dds-topology-lib/src/Task.h

Go to the documentation of this file.

// Copyright 2014 GSI, Inc. All rights reserved.
//
//
//

#ifndef __DDS__Task__
#define __DDS__Task__

// DDS
#include "Requirement.h"
#include "TopoElement.h"
#include "TopoProperty.h"
#include "Trigger.h"
// STD
#include <memory>
#include <string>

namespace dds
{
    namespace topology_api
    {
        class CTask : public CTopoElement
        {
          public:
            CTask();

            virtual ~CTask();

            const std::string& getExe() const;
            const std::string& getEnv() const;
            bool isExeReachable() const;
            bool isEnvReachable() const;
            size_t getNofProperties() const;
            size_t getNofRequirements() const;
            size_t getNofTriggers() const;
            TopoPropertyPtr_t getProperty(size_t _i) const;
            const TopoPropertyPtrVector_t& getProperties() const;
            const RequirementPtrVector_t& getRequirements() const;
            const TriggerPtrVector_t& getTriggers() const;
            TopoPropertyPtr_t getProperty(const std::string& _id) const;

            void setExe(const std::string& _exe);
            void setEnv(const std::string& _env);
            void setExeReachable(bool _exeReachable);
            void setEnvReachable(bool _envReachable);
            void setProperties(const TopoPropertyPtrVector_t& _properties);
            void addProperty(TopoPropertyPtr_t _property);
            void setRequirements(const RequirementPtrVector_t& _requirements);
            void addRequirement(RequirementPtr_t _requirement);
            void setTriggers(const TriggerPtrVector_t& _triggers);
            void addTrigger(TriggerPtr_t _trigger);

            // Parent collection and group ID
            std::string getParentCollectionId() const;
            std::string getParentGroupId() const;

            size_t getTotalCounter() const;

            virtual size_t getNofTasks() const;

            virtual size_t getTotalNofTasks() const;

            virtual void initFromPropertyTree(const std::string& _name, const boost::property_tree::ptree& _pt);

            virtual std::string toString() const;

            friend std::ostream& operator<<(std::ostream& _strm, const CTask& _task);

          private:
            std::string m_exe;                     
            std::string m_env;                     
            bool m_exeReachable;                   
            bool m_envReachable;                   
            TopoPropertyPtrVector_t m_properties;  
            RequirementPtrVector_t m_requirements; 
            TriggerPtrVector_t m_triggers;         
        };

        typedef std::shared_ptr<CTask> TaskPtr_t;
        typedef std::vector<TaskPtr_t> TaskPtrVector_t;
    }
}
#endif /* defined(__DDS__Task__) */