map_trigger.h

Go to the documentation of this file.

 
#ifndef HEADER_MAP_TRIGGER_H
#define HEADER_MAP_TRIGGER_H
 
#include <a_util/result.h>
#include <a_util/xml.h>
 
#include <string>
#include <vector>
 
namespace ddl {
namespace mapping {
class MapConfiguration;
class MapTriggerBase {
public:
    MapTriggerBase(MapConfiguration* config);

    virtual ~MapTriggerBase();

    bool isValid() const;

    virtual std::string getSourceDependency() const;

    virtual bool isEqual(const MapTriggerBase& other) const = 0;

    bool checkValidity();

    a_util::result::Result checkTriggerReferences() const;
 
protected:
    virtual MapTriggerBase* clone() const = 0;
 
private:
    static a_util::result::Result createFromDOM(MapConfiguration* config,
                                                const a_util::xml::DOMElement& dom_element,
                                                MapTriggerBase*& destination);

    a_util::result::Result writeToDOM(a_util::xml::DOMElement& dom_element) const;

    a_util::result::Result setSourceDependency(const std::string& new_name);
 
protected:
    friend class MapConfiguration;
    friend class MapTarget;
    MapConfiguration* _config;
    bool _is_valid;
};

class MapPeriodicTrigger : public MapTriggerBase {
public:
    MapPeriodicTrigger(MapConfiguration* config);

    double getPeriod() const;

    a_util::result::Result setPeriod(const std::string& period, const std::string& unit);

    bool isEqual(const MapTriggerBase& other) const;
 
protected:
    // implements MapTriggerBase
    MapTriggerBase* clone() const;
 
private:
    a_util::result::Result loadFromDom(const a_util::xml::DOMElement& dom_element);

    a_util::result::Result writeToDOM(a_util::xml::DOMElement& dom_element) const;
 
private:
    friend class MapTriggerBase;
    double _period;
};

class MapSignalTrigger : public MapTriggerBase {
public:
    MapSignalTrigger(MapConfiguration* config);

    virtual std::string getSourceDependency() const;

    const std::string& getVariable() const;

    a_util::result::Result setVariable(const std::string& signal_name);

    bool isEqual(const MapTriggerBase& other) const;
 
protected:
    // implements MapTriggerBase
    MapTriggerBase* clone() const;
 
private:
    a_util::result::Result loadFromDom(const a_util::xml::DOMElement& dom_element);

    a_util::result::Result writeToDOM(a_util::xml::DOMElement& dom_element) const;

    a_util::result::Result setVariableNoTypeCheck(const std::string& signal_name);
 
private:
    friend class MapConfiguration;
    friend class MapTriggerBase;
    std::string _variable;
    bool _is_valid;
};

class MapDataTrigger : public MapTriggerBase {
public:
    MapDataTrigger(MapConfiguration* config);

    virtual std::string getSourceDependency() const;

    const std::string& getVariable() const;

    const std::string& getSource() const;

    const std::string& getOperator() const;

    double getValue() const;

    a_util::result::Result setComparison(const std::string& source_element_path,
                                         const std::string& comp_operator,
                                         const std::string& value);

    bool isEqual(const MapTriggerBase& other) const;
 
protected: // implements MapTriggerBase
    MapTriggerBase* clone() const;
 
private:
    a_util::result::Result loadFromDom(const a_util::xml::DOMElement& trigger_element);

    a_util::result::Result writeToDOM(a_util::xml::DOMElement& dom_element) const;

    a_util::result::Result setComparisonNoTypeCheck(const std::string& source_element_path,
                                                    const std::string& comp_operator,
                                                    const std::string& value);

    a_util::result::Result setSourceNoTypeCheck(const std::string& source);
 
private:
    friend class MapConfiguration;
    friend class MapTriggerBase;
    std::string _variable;
    std::string _source;
    std::string _operator;
    double _value;
};

typedef std::vector<MapTriggerBase*> MapTriggerList;
 
} // namespace mapping
} // namespace ddl
 
#endif // HEADER_MAP_TRIGGER_H