StatechartContext.h

Go to the documentation of this file.

/*
* This file is part of ArmarX.
*
* Copyright (C) 2011-2016, High Performance Humanoid Technologies (H2T), Karlsruhe Institute of Technology (KIT), all rights reserved.
*
* ArmarX is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* ArmarX is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @package    ArmarXCore::Statechart
* @author     Mirko Waechter( mirko.waechter at kit dot edu)
* @date       2012
* @copyright  http://www.gnu.org/licenses/gpl-2.0.txt
*             GNU General Public License
*/
#pragma once
#ifndef _ARMARX_CORE_STATECHARTCONTEXT_H
#define _ARMARX_CORE_STATECHARTCONTEXT_H
 
 
#include "StatechartContextInterface.h"
#include "StatechartEventDistributor.h"
#include "../core/Component.h"
 
#include <ArmarXCore/interface/observers/SystemObserverInterface.h>
#include <ArmarXCore/interface/observers/ConditionHandlerInterface.h>
 
#include <unordered_map>
 
 
namespace armarx
{
    class StatechartEventDistributor;
    using StatechartEventDistributorPtr = IceInternal::Handle<StatechartEventDistributor>;
 
    class State;
    using StatePtr = IceInternal::Handle<State>;
 
    class DataFieldIdentifier;
 
    class StatechartManager;
    using StatechartManagerPtr = IceUtil::Handle<StatechartManager>;
 
    using StatechartProfilePtr = std::shared_ptr<class StatechartProfile>;
 
 
    /**
     * @brief The StatechartContextPropertyDefinitions class contains properties associated with all statecharts
     */
    class StatechartContextPropertyDefinitions :
        public armarx::ComponentPropertyDefinitions
    {
    public:
        StatechartContextPropertyDefinitions(std::string prefix);
    };
 
 
    /**
      \class StatechartContext
      \ingroup StatechartGrp
      \brief This class contains a statechart and provides the interfaces to distributed components.
 
      This class inherits from armarx::Component and should be the entry point for applications containing a statechart.
      This class contains all the proxies to distributed components like the ConditionHandler
      or the KinematicUnit.\n
      This class should only be created once per application and the top-level state of this StatechartContext
      should be set via armarx::StatechartContext::setToplevelState().
 
      The StatechartContext is available from the State-implementations with
      StateBase::getContext<StatechartContextType>().
 
      If a statechart needs other proxies to Ice objects (\see armarx::ManagedIceObject), this class
      needs to be subclassed and armarx::StatechartContext::onInitStatechartContext()
      and armarx::StatechartContext::onConnectStatechartContext() reimplemented.
      But keep in mind to call armarx::StatechartContext::onInitStatechartContext() and
      armarx::StatechartContext::onConnectStatechartContext() (or the intermediate statechart context, from
      which you are deriving) in your reimplentation.
 
      \snippet
      */
    class StatechartContext :
        virtual public Component,
        public StatechartContextInterface
    {
    private:
        // inherited from Component
        void onInitComponent() override;
        void onConnectComponent() override;
        void onDisconnectComponent() override;
        void onExitComponent() override;
 
    protected:
        /**
         * @brief onInitStatechartonInitStatechartContext can be implemented by subclasses
         *
         * Override this method to specify required proxies and topics via armarx::Component::usingProxy(),
         * armarx::Component::usingTopic() and armarx::Component::offeringTopic().
         *
         * This method is calle by armarx::StatechartContext::onInitComponent().
         */
        virtual void onInitStatechartContext() {}
 
        /**
         * @brief onConnectStatechartContext can be implemented by subclasses
         *
         * Override this method to retrieve the proxies and topics specified in armarx::StatechartContext::onInitStatechart()
         * via armarx::Component::getProxy() and armarx::Component::getTopic().
         *
         * This method is called by armarx::StatechartContext::onConnectComponent().
         */
        virtual void onConnectStatechartContext() {}
    public:
        StatechartContext();
        ~StatechartContext() override;
 
        /**
         * @see PropertyUser::createPropertyDefinitions()
         */
        PropertyDefinitionsPtr createPropertyDefinitions() override;
 
        TimedVariantBaseList getDataListFromObserver(std::string observerName, const DataFieldIdentifierBaseList& identifierList) override;
        VariantBasePtr getDataFromObserver(const DataFieldIdentifierBasePtr& identifier) override;
        ChannelRefPtr getChannelRef(const std::string& observerName, const std::string& channelName) override;
        DatafieldRefPtr getDatafieldRef(const DataFieldIdentifier& datafieldIdentifier) override;
        DatafieldRefPtr getDatafieldRef(ChannelRefPtr channelRef, const std::string& datafieldName) override;
 
        //! use the Component::getIceManager() method in this object class
        using Component::getIceManager;
 
        /**
         * @brief setToplevelState initializes \p newToplevelState with the current StatechartContext and the current StatechartContext::statechartManager
         * and sets \p newToplevelState as top-level state on the current StatechartContext::statechartManager.
         * @param newToplevelState
         * @param startParameters
         * @return
         */
        bool setToplevelState(const armarx::StatePtr& newToplevelState, StringVariantContainerBaseMap startParameters = StringVariantContainerBaseMap());
 
        /**
         * @brief setAutoStartStatechart controls whether the toplevelstate is
         * automatically entered, when the statechart manager is started,
         * @param autostart
         */
        void setAutoEnterToplevelState(bool autoEnter);
 
        void setReportingTopic(std::string reportingTopic);
 
        /**
         * @brief startStatechart actives both, the toplevel startchart stored
         * in the variable statechart and the StatechartManager for handling
         * eventprocessing.
         */
        void startStatechart();
 
        /**
         * @brief onInitStatechart this method is called when the statechart is started. \see armarx::RemoteStateOfferer
         */
        virtual void onInitStatechart() = 0;
 
        /**
         * @brief onConnectStatechart is called before armarx::StatechartContext::startStatechart() and after armarx::StatechartContext::onConnectStatechartContext()
         */
        virtual void onConnectStatechart() = 0;
        /**
         * @brief onExitStatechart can be implemented by subclasses
         *
         * Override this method to perform cleanup tasks when the statechart is left.
         */
        virtual void onExitStatechart() {}
 
        std::unordered_map<std::string, ObserverInterfacePrx> observerMap;
 
        /**
         * The EventListenerInterface instance, that receives events from observers and redirects them to the correct states
         */
        StatechartEventDistributorPtr eventDistributor;
        StatechartManagerPtr statechartManager;
        ConditionHandlerInterfacePrx conditionHandlerPrx;
        SystemObserverInterfacePrx systemObserverPrx;
 
    protected:
        bool autoEnterToplevelState;
        Profiler::ProfilerPtr stateReporter;
        std::string reportingTopic;
    };
    using StatechartContextPtr = IceInternal::Handle<StatechartContext>;
 
    class XMLStatechartContext : public StatechartContext
    {
    public:
        const StatechartProfilePtr& getSelectedStatechartProfile() const;
 
 
    protected:
        void setSelectedStatechartProfile(const StatechartProfilePtr& value);
 
    private:
        StatechartProfilePtr selectedStatechartProfile;
        friend class XMLStateComponent;
    };
 
}
 
#endif