TopoBase.h

Go to the documentation of this file.

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

#ifndef __DDS__TopoBase__
#define __DDS__TopoBase__

// STD
#include <sstream>
#include <string>
#include <vector>
// BOOST
#include <boost/property_tree/ptree.hpp>

namespace dds
{
    namespace topology_api
    {
        class CTopoBase
        {
          public:
            enum class EType
            {
                TOPO_BASE,
                TOPO_PROPERTY,
                TOPO_ELEMENT,
                TASK,
                COLLECTION,
                GROUP,
                REQUIREMENT,
                TOPO_VARS,
                TRIGGER
            };

            using Ptr_t = std::shared_ptr<CTopoBase>;
            using PtrVector_t = std::vector<CTopoBase::Ptr_t>;

            void setName(const std::string& _name);
            void setParent(CTopoBase* _parent);

            const std::string& getName() const;
            CTopoBase::EType getType() const;
            CTopoBase* getParent() const;

            std::string getPath() const;

            template <class Object_t>
            static typename Object_t::Ptr_t make(const std::string& _objectName,
                                                 const std::string& _filepath,
                                                 const std::string& _schemaFilepath = "",
                                                 std::string* _topologyName = nullptr)
            {
                typename Object_t::Ptr_t newObject{ std::make_shared<Object_t>(_objectName) };
                newObject->initFromXML(_filepath, _schemaFilepath, _topologyName);
                return newObject;
            }

            template <class Object_t>
            static typename Object_t::Ptr_t make(const std::string& _objectName,
                                                 std::istream& _stream,
                                                 const std::string& _schemaFilepath = "",
                                                 std::string* _topologyName = nullptr)
            {
                typename Object_t::Ptr_t newObject{ std::make_shared<Object_t>(_objectName) };
                newObject->initFromXML(_stream, _schemaFilepath, _topologyName);
                return newObject;
            }

            template <class Object_t>
            static typename Object_t::Ptr_t make(const std::string& _name, const boost::property_tree::ptree& _pt)
            {
                typename Object_t::Ptr_t newObject{ std::make_shared<Object_t>(_name) };
                newObject->initFromPropertyTree(_pt);
                return newObject;
            }

            void initFromXML(const std::string& _filepath,
                             const std::string& _schemaFilepath = "",
                             std::string* _topologyName = nullptr);

            void initFromXML(std::istream& _stream,
                             const std::string& _schemaFilepath = "",
                             std::string* _topologyName = nullptr);

            virtual void initFromPropertyTree(const boost::property_tree::ptree& _pt) = 0;

            virtual void saveToPropertyTree(boost::property_tree::ptree& _pt) = 0;

            virtual std::string toString() const;

            friend std::ostream& operator<<(std::ostream& _strm, const CTopoBase& _element);

            virtual std::string hashString() const = 0;

          protected:
            CTopoBase(const std::string& _name);

            virtual ~CTopoBase();

            void setType(CTopoBase::EType _type);

          private:
            std::string m_name;                          
            CTopoBase::EType m_type{ EType::TOPO_BASE }; 
            CTopoBase* m_parent{ nullptr };              
        };
    } // namespace topology_api
} // namespace dds
#endif /* defined(__DDS__TopoBase__) */