libs/orcaice/context.h

/*
 * Orca-Robotics Project: Components for robotics 
 *               http://orca-robotics.sf.net/
 * Copyright (c) 2004-2009 Alex Brooks, Alexei Makarenko, Tobias Kaupp
 *
 * This copy of Orca is licensed to you under the terms described in
 * the LICENSE file included in this distribution.
 *
 */

#ifndef ORCAICE_COMPONENT_CONTEXT_H
#define ORCAICE_COMPONENT_CONTEXT_H

// We carefully select the minimum subset of Ice include file we commonly need.
// It would be easier to just include <Ice/Ice.h> at the expense of more includes
// and slower compilation. We are trying to be careful because this file is included
// by practically everything in Orca.
#include <Ice/Communicator.h>
#include <Ice/ObjectAdapter.h>
#include <Ice/Properties.h>
#include <Ice/LocalException.h>

#include <orca/ocm.h>
#include <orcaice/home.h>
#include <gbxutilacfr/tracer.h>
#include <gbxutilacfr/status.h>
#include <hydroutil/history.h>
#include <hydroutil/context.h>

namespace orcaice
{

class Component;

class Context
{
friend class Component;

public:
    // We need the empty constructor because the original one is constucted a bit at a time
    // during component initialization.
    // We don't document this constuctor because the user typically only sees the copy constructor.
    Context();

    const std::string&     tag() const { return tag_; };

    const orca::FQComponentName& name() const { return name_; };

    bool                   isApplication() const { return isApplication_; };

    Ice::CommunicatorPtr   communicator() const { return communicator_; };

    Ice::ObjectAdapterPtr  adapter() const { return adapter_; };

    Ice::PropertiesPtr     properties() const { return communicator_->getProperties(); };

    orcaice::Home&         home() const { return *home_; };
    gbxutilacfr::Tracer&     tracer() const { return *tracer_; };
    gbxutilacfr::Status&     status() const { return *status_; };
    hydroutil::History&    history() const { return *history_; };


    void activate();

    bool isDeactivating();

    void shutdown() const;

    // WARNING to internal developers:
    // Do not call these functions before the context is fully initialized, i.e.
    // before Component::start() is called.
    hydroutil::Context toHydroContext( const std::string &prefixToStrip ) const;

    hydroutil::Context toHydroContext() const;

    std::string toString() const;

private:

    // this function should only be called by Component (it can because it's a friend)
    void init( const orca::FQComponentName& name,
               const bool isApp,
               const Ice::ObjectAdapterPtr& adapter );

    std::string            tag_;
    orca::FQComponentName  name_;
    bool                   isApplication_;
    Ice::CommunicatorPtr   communicator_;
    Ice::ObjectAdapterPtr  adapter_;

    // Context does not take responsibility for these objects, i.e. does not destroy them
    orcaice::Home*         home_;
    gbxutilacfr::Tracer*   tracer_;
    gbxutilacfr::Status*   status_;
    hydroutil::History*    history_;
};

} // end namespace

#endif