AbstractAction.h

Go to the documentation of this file.

// Copyright CERN 2012 - Developed in collaboration with GSI
#ifndef ABSTRACTACTION_H_
#define ABSTRACTACTION_H_

#include <fesa-core/Core/AbstractDeviceClass.h>

#include <string>
#include <vector>
#include <map>
#include <boost/shared_ptr.hpp>

namespace fesa
{

class AbstractServiceLocator;
class AbstractDeviceClass;
class MultiplexingContext;
class OnDemandProducer;

class AbstractAction
{
        public:
                AbstractAction(std::string& actionName, std::string& className, const AbstractServiceLocator* serviceLocator, const std::map<std::string, const AbstractServiceLocator*> serviceLocatorRelatedClasses);
                virtual ~AbstractAction();

                const std::string& getName();

                static const uint32_t DEFAULT_ON_DEMAND_MESSAGE_PRIO = 0;

                void triggerOnDemandEventSource(const std::string& sourceName, MultiplexingContext* pCtxt, uint32_t msgPrio=DEFAULT_ON_DEMAND_MESSAGE_PRIO);

                void triggerOnDemandEventSource(const std::string& sourceName, MultiplexingContext* pCtxt, const char* payload, uint32_t payloadSize, uint32_t msgPrio=DEFAULT_ON_DEMAND_MESSAGE_PRIO);

                void triggerAllOnDemandEventSources(MultiplexingContext* pCtxt, uint32_t msgPrio=DEFAULT_ON_DEMAND_MESSAGE_PRIO);

                void triggerAllAutomaticallyTriggeredOnDemandEventSources(MultiplexingContext* pCtxt, uint32_t msgPrio=DEFAULT_ON_DEMAND_MESSAGE_PRIO);

                struct OnDemandProducerRef
                {
                        bool triggerAutomatically;
                        boost::shared_ptr<OnDemandProducer> onDemandProducer;
                };

        protected:

                std::string name_;

                //TODO Why not just store a pointer to the corresponding AbstractDeviceClass ?
                std::string className_;

                const AbstractServiceLocator* serviceLocator_;

                const std::map<std::string, const AbstractServiceLocator*> serviceLocatorRelatedClasses_;

                typedef const std::string OnDemandEventSourceName;
                typedef std::map< OnDemandEventSourceName,OnDemandProducerRef> OnDemandEventProducerCollection;
                //Producers for all on-demand event-sources which can be triggered by this action
                OnDemandEventProducerCollection onDemandEventProducerCol_;

};

inline const std::string& AbstractAction::getName()
{
        return name_;
}

}
#endif /* ABSTRACTACTION_H_ */