TopoProperty.h

Go to the documentation of this file.

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

#ifndef __DDS__TopoProperty__
#define __DDS__TopoProperty__

// DDS
#include "TopoBase.h"
// STD
#include <map>
#include <sstream>
#include <string>

namespace dds
{
    namespace topology_api
    {
        class CTopoProperty : public CTopoBase
        {
          public:
            enum class EAccessType
            {
                READ,
                WRITE,
                READWRITE
            };

            enum class EScopeType
            {
                GLOBAL,
                COLLECTION
            };

            using Ptr_t = std::shared_ptr<CTopoProperty>;
            // Property ID --> Ptr
            using PtrMap_t = std::map<std::string, CTopoProperty::Ptr_t>;

            CTopoProperty(const std::string& _name);

            virtual ~CTopoProperty();

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

            void saveToPropertyTree(boost::property_tree::ptree& _pt);

            const std::string& getValue() const;
            void setValue(const std::string& _value);
            CTopoProperty::EAccessType getAccessType() const;
            void setAccessType(CTopoProperty::EAccessType _accessType);
            CTopoProperty::EScopeType getScopeType() const;
            void setScopeType(CTopoProperty::EScopeType _scopeType);

            virtual std::string toString() const;

            friend std::ostream& operator<<(std::ostream& _strm, const CTopoProperty& _property);

            virtual std::string hashString() const;

          private:
            std::string m_value;                                                              
            CTopoProperty::EAccessType m_accessType{ CTopoProperty::EAccessType::READWRITE }; 
            CTopoProperty::EScopeType m_scopeType{ CTopoProperty::EScopeType::GLOBAL };       
        };
    } // namespace topology_api
} // namespace dds
#endif /* defined(__DDS__TopoProperty__) */