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

#include <TopoRequirement.h>

Inheritance diagram for dds::topology_api::CTopoRequirement:
dds::topology_api::CTopoBase

Public Types

enum  EType { EType::WnName, EType::HostName, EType::Gpu, EType::MaxInstancesPerHost }
 
using Ptr_t = std::shared_ptr< CTopoRequirement >
 
using PtrVector_t = std::vector< CTopoRequirement::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

 CTopoRequirement (const std::string &_name)
 Constructor. More...
 
virtual ~CTopoRequirement ()
 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
 
CTopoRequirement::EType getRequirementType () const
 
void setValue (const std::string &_value)
 
void setRequirementType (CTopoRequirement::EType _requireemntType)
 
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 CTopoRequirement &_requirement)
 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

◆ PtrVector_t

Member Enumeration Documentation

◆ EType

Enumerator
WnName 
HostName 
Gpu 
MaxInstancesPerHost 

Constructor & Destructor Documentation

◆ CTopoRequirement()

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

Constructor.

◆ ~CTopoRequirement()

CTopoRequirement::~CTopoRequirement ( )
virtual

Destructor.

Member Function Documentation

◆ getRequirementType()

CTopoRequirement::EType CTopoRequirement::getRequirementType ( ) const

◆ getValue()

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

◆ hashString()

string CTopoRequirement::hashString ( ) const
virtual

Inherited from TopoBase.

Implements dds::topology_api::CTopoBase.

◆ initFromPropertyTree()

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

Inherited from TopoBase.

Implements dds::topology_api::CTopoBase.

◆ saveToPropertyTree()

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

Inherited from TopoBase.

Implements dds::topology_api::CTopoBase.

◆ setRequirementType()

void CTopoRequirement::setRequirementType ( CTopoRequirement::EType  _requireemntType)

◆ setValue()

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

◆ toString()

string CTopoRequirement::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 CTopoRequirement _requirement 
)
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: