DDS  ver. 3.5.3.8.g5fe284b
Public Types | Public Member Functions | Friends | List of all members
dds::topology_api::CTopoProperty Class Reference

#include <TopoProperty.h>

Inheritance diagram for dds::topology_api::CTopoProperty:
dds::topology_api::CTopoBase

Public Types

enum  EAccessType { EAccessType::READ, EAccessType::WRITE, EAccessType::READWRITE }
 
enum  EScopeType { EScopeType::GLOBAL, EScopeType::COLLECTION }
 
using Ptr_t = std::shared_ptr< CTopoProperty >
 
using PtrMap_t = std::map< std::string, CTopoProperty::Ptr_t >
 
- Public Types inherited from dds::topology_api::CTopoBase
enum  EType {
  EType::TOPO_BASE, EType::TOPO_PROPERTY, EType::TOPO_ELEMENT, EType::TASK,
  EType::COLLECTION, EType::GROUP, EType::REQUIREMENT, EType::TOPO_VARS,
  EType::TRIGGER
}
 
using Ptr_t = std::shared_ptr< CTopoBase >
 
using PtrVector_t = std::vector< CTopoBase::Ptr_t >
 

Public Member Functions

 CTopoProperty (const std::string &_name)
 Constructor. More...
 
virtual ~CTopoProperty ()
 Destructor. More...
 
void initFromPropertyTree (const boost::property_tree::ptree &_pt)
 Inherited from TopoBase. More...
 
void saveToPropertyTree (boost::property_tree::ptree &_pt)
 Inherited from TopoBase. More...
 
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
 Returns string representation of an object. More...
 
virtual std::string hashString () const
 Inherited from TopoBase. More...
 
- Public Member Functions inherited from dds::topology_api::CTopoBase
void setName (const std::string &_name)
 Modifiers. More...
 
void setParent (CTopoBase *_parent)
 
const std::string & getName () const
 Accessors. More...
 
CTopoBase::EType getType () const
 
CTopoBasegetParent () const
 
std::string getPath () const
 Return full path to topo element or property. More...
 
void initFromXML (const std::string &_filepath, const std::string &_schemaFilepath="", std::string *_topologyName=nullptr)
 Initializes object with data from XML file. More...
 
void initFromXML (std::istream &_stream, const std::string &_schemaFilepath="", std::string *_topologyName=nullptr)
 Initializes object with data from XML input stream. More...
 

Friends

std::ostream & operator<< (std::ostream &_strm, const CTopoProperty &_property)
 Operator << for convenient output to ostream. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from dds::topology_api::CTopoBase
template<class Object_t >
static Object_t::Ptr_t make (const std::string &_objectName, const std::string &_filepath, const std::string &_schemaFilepath="", std::string *_topologyName=nullptr)
 Convenience API to create topology object from XML file. More...
 
template<class Object_t >
static Object_t::Ptr_t make (const std::string &_objectName, std::istream &_stream, const std::string &_schemaFilepath="", std::string *_topologyName=nullptr)
 Convenience API to create topology object from XML file. More...
 
template<class Object_t >
static Object_t::Ptr_t make (const std::string &_name, const boost::property_tree::ptree &_pt)
 Convenience API to create topology object with data from property tree. More...
 
- Protected Member Functions inherited from dds::topology_api::CTopoBase
 CTopoBase (const std::string &_name)
 Constructor. More...
 
virtual ~CTopoBase ()
 Destructor. More...
 
void setType (CTopoBase::EType _type)
 

Member Typedef Documentation

◆ Ptr_t

◆ PtrMap_t

Member Enumeration Documentation

◆ EAccessType

Enumerator
READ 
WRITE 
READWRITE 

◆ EScopeType

Enumerator
GLOBAL 
COLLECTION 

Constructor & Destructor Documentation

◆ CTopoProperty()

CTopoProperty::CTopoProperty ( const std::string &  _name)

Constructor.

◆ ~CTopoProperty()

CTopoProperty::~CTopoProperty ( )
virtual

Destructor.

Member Function Documentation

◆ getAccessType()

CTopoProperty::EAccessType CTopoProperty::getAccessType ( ) const

◆ getScopeType()

CTopoProperty::EScopeType CTopoProperty::getScopeType ( ) const

◆ getValue()

const std::string & CTopoProperty::getValue ( ) const

◆ hashString()

string CTopoProperty::hashString ( ) const
virtual

Inherited from TopoBase.

Implements dds::topology_api::CTopoBase.

◆ initFromPropertyTree()

void CTopoProperty::initFromPropertyTree ( const boost::property_tree::ptree &  _pt)
virtual

Inherited from TopoBase.

Implements dds::topology_api::CTopoBase.

◆ saveToPropertyTree()

void CTopoProperty::saveToPropertyTree ( boost::property_tree::ptree &  _pt)
virtual

Inherited from TopoBase.

Implements dds::topology_api::CTopoBase.

◆ setAccessType()

void CTopoProperty::setAccessType ( CTopoProperty::EAccessType  _accessType)

◆ setScopeType()

void CTopoProperty::setScopeType ( CTopoProperty::EScopeType  _scopeType)

◆ setValue()

void CTopoProperty::setValue ( const std::string &  _value)

◆ toString()

string CTopoProperty::toString ( ) const
virtual

Returns string representation of an object.

Returns
String representation of an object.

Reimplemented from dds::topology_api::CTopoBase.

Friends And Related Function Documentation

◆ operator<<

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

Operator << for convenient output to ostream.

Returns
Insertion stream in order to be able to call a succession of insertion operations.

The documentation for this class was generated from the following files: