AbstractRTDeviceClass.h

Go to the documentation of this file.

// Copyright CERN 2012 - Developed in collaboration with GSI

#ifndef ABSTRACT_RT_DEVICE_CLASS_H_
#define ABSTRACT_RT_DEVICE_CLASS_H_

#include <string>
#include <vector>
#include <set>
#include <map>
#include <fesa-core/Core/AbstractDeviceClass.h>
#include <fesa-core/Utilities/Thread.h>
#include <fesa-core/RealTime/AbstractEventSourceFactory.h>
#include <fesa-core/Utilities/XMLParser.h> 
namespace fesa {

const std::string DIAG_LAYER_NAME ="DiagnosticLayer";
const std::string DIAG_EVENT_SOURCE_NAME ="DiagnosticEventSource";

class AbstractDeviceFactory;
class AbstractDevice;
//class EventsMappingElement
struct RTSchedulingUnitInfo {
        std::string name_;

        std::string actionName_;

        std::string className_;

        std::string selectionCriterion_;

        std::string eventName_;

        bool isEventOptional_;

        std::string eventField_;

};

/*
 * \struct RTActionInfo
 * \brief this structure contains the information related to the RealTime actions
 */
struct RTActionInfo {
        std::string className_;

    std::set<std::string> automaticallyNotifiedPropertiesCol_;

        bool isGlobalPropertyToBeNotified_;

    std::set<std::string> manuallyNotifiedPropertiesCol_;

};

class AbstractRTActionFactory;

class AbstractRTDeviceClass: public AbstractDeviceClass
{

public:

        typedef std::set<std::string> RTActionNameCol;
        typedef std::map<std::string, RTActionNameCol> DerivedClassesRTActionCol;
        typedef std::map<std::string, RTActionInfo*> RTActionInfoCol;

        AbstractRTDeviceClass(const std::string& name, const std::string& version);

        //To make it possible to mock this object
        AbstractRTDeviceClass();

        virtual ~AbstractRTDeviceClass();

        virtual AbstractRTActionFactory* getRTActionFactory();

        virtual AbstractEventSourceFactory* getEventSourceFactory();

        virtual void initialize();

        virtual void addDiagnosticSchedulingUnitInfo(std::vector<RTSchedulingUnitInfo*>& schedulingUnitInfo);

        virtual void addDiagnosticRTActionInfo(RTActionInfoCol& actionInfoCol);

        virtual void addDiagnosticEvents(ElementXML* xmlElementClass);

protected:

        friend class RTController;

        virtual void fillRTSchedulingUnitsInfo(
                        std::vector<RTSchedulingUnitInfo*>& schedulingUnitInfo) = 0;

        virtual void fillRTActionInfo(RTActionInfoCol& actionInfo) = 0;

        AbstractRTActionFactory* rtActionFactory_;

        AbstractEventSourceFactory* eventSourceFactory_;

private:

    ElementXML* getOrCreateXMLElement(ElementXML* baseElement,std::string name);

    void addXMLAttribute(ElementXML* baseElement,std::string name,std::string value);


};

/*************************************************************************/

inline AbstractRTActionFactory* AbstractRTDeviceClass::getRTActionFactory() {
        return rtActionFactory_;
}

inline AbstractEventSourceFactory* AbstractRTDeviceClass::getEventSourceFactory() {
        return eventSourceFactory_;
}

}

#endif /* ABSTRACT_RT_DEVICE_CLASS_H_ */