dds::topology_api::CTopoVars Class Reference

#include <TopoVars.h>

Inheritance diagram for dds::topology_api::CTopoVars:

Public Types
using	Ptr_t = std::shared_ptr< CTopoVars >
using	varMap_t = std::map< std::string, std::string >
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
	CTopoVars (const std::string &_name)
	Constructor. More...
virtual	~CTopoVars ()
	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...
virtual std::string	toString () const
	Returns string representation of an object. More...
virtual std::string	hashString () const
	Inherited from TopoBase. More...
const varMap_t &	getMap () const
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
CTopoBase *	getParent () 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 CTopoVars &_vars)
	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

using dds::topology_api::CTopoVars::Ptr_t = std::shared_ptr<CTopoVars>

varMap_t

using dds::topology_api::CTopoVars::varMap_t = std::map<std::string, std::string>

Constructor & Destructor Documentation

CTopoVars()

CTopoVars::CTopoVars

(

const std::string &

_name

)

Constructor.

~CTopoVars()

CTopoVars::~CTopoVars ( )

virtual

Destructor.

Member Function Documentation

getMap()

const CTopoVars::varMap_t & CTopoVars::getMap

(

)

const

hashString()

string CTopoVars::hashString ( ) const

virtual

Inherited from TopoBase.

Implements dds::topology_api::CTopoBase.

initFromPropertyTree()

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

virtual

Inherited from TopoBase.

Implements dds::topology_api::CTopoBase.

saveToPropertyTree()

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

virtual

Inherited from TopoBase.

Implements dds::topology_api::CTopoBase.

toString()

string CTopoVars::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 CTopoVars &  _vars  )

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:

• TopoVars.h
• TopoVars.cpp