dds::topology_api::CTopology Class Reference

#include <Topology.h>

Public Member Functions
	CTopology ()
	Default constructor. More...
	~CTopology ()
	Destructor. More...
	CTopology (const std::string &_fileName, const std::string &_schemaFileName="")
	Constructs a topology with the specified file and validates against a schema file (if not empty). More...
	CTopology (std::istream &_stream, const std::string &_schemaFileName="")
	Constructs a topology from stream and validates against a schema file (if not empty). More...
std::string	getName () const
	Returns topology name. More...
std::string	getFilepath () const
	Returns topology filepath or empty string if topology is not initialized. More...
uint32_t	getHash () const
	Returns topology hash. More...
CTopoGroup::Ptr_t	getMainGroup () const
	Returns shared pointer to the main group of the topology. More...
const STopoRuntimeTask &	getRuntimeTaskById (Id_t _id) const
	Returns runtime task by ID. More...
const STopoRuntimeCollection &	getRuntimeCollectionById (Id_t _id) const
	Returns runtime collection by ID. More...
const STopoRuntimeTask &	getRuntimeTaskByIdPath (const std::string &_idPath) const
	Returns runtime task by path. More...
const STopoRuntimeCollection &	getRuntimeCollectionByIdPath (const std::string &_idPath) const
	Returns runtime collection by path. More...
const STopoRuntimeTask &	getRuntimeTask (const std::string &_path) const
	Returns runtime task by either ID or runtime path. More...
const STopoRuntimeCollection &	getRuntimeCollection (const std::string &_path) const
	Returns runtime collection by either ID or runtime path. More...
STopoRuntimeTask::FilterIteratorPair_t	getRuntimeTaskIterator (STopoRuntimeTask::Condition_t _condition=nullptr) const
	Returns runtime task filter iterator. More...
STopoRuntimeCollection::FilterIteratorPair_t	getRuntimeCollectionIterator (STopoRuntimeCollection::Condition_t _condition=nullptr) const
	Returns runtime collection filter iterator. More...
STopoRuntimeTask::FilterIteratorPair_t	getRuntimeTaskIteratorMatchingPath (const std::string &_pathPattern) const
	Returns runtime task filter iterator matching the task path in the topology. More...
STopoRuntimeCollection::FilterIteratorPair_t	getRuntimeCollectionIteratorMatchingPath (const std::string &_pathPattern) const
	Returns runtime collection filter iterator matching the collection path in the topology. More...
std::pair< size_t, size_t >	getRequiredNofAgents (size_t _defaultNumSlots) const
	Returns required number of agents and slots for the topology as std::pair. More...
size_t	getRequiredNofAgents () const
	Returns required number of agents and slots for the topology as std::pair. More...
size_t	getTotalNofTasks () const
	Returns total number of tasks in the topology. More...

Constructor & Destructor Documentation

CTopology() [1/3]

CTopology::CTopology

(

)

Default constructor.

~CTopology()

CTopology::~CTopology

(

)

Destructor.

CTopology() [2/3]

dds::topology_api::CTopology::CTopology	(	const std::string &	_fileName,
		const std::string &	_schemaFileName = ""
	)

Constructs a topology with the specified file and validates against a schema file (if not empty).

Parameters

[in]	_fileName	Path to the topology file.
[in]	_schemaFileName	Path to the XSD schema file.

Exceptions

runtime_error

CTopology() [3/3]

dds::topology_api::CTopology::CTopology	(	std::istream &	_stream,
		const std::string &	_schemaFileName = ""
	)

Constructs a topology from stream and validates against a schema file (if not empty).

Parameters

[in]	_stream	Input stream.
[in]	_schemaFileName	Path to the XSD schema file.

Exceptions

runtime_error

Member Function Documentation

getFilepath()

string CTopology::getFilepath

(

)

const

Returns topology filepath or empty string if topology is not initialized.

getHash()

uint32_t CTopology::getHash

(

)

const

Returns topology hash.

Exceptions

runtime_error

getMainGroup()

CTopoGroup::Ptr_t CTopology::getMainGroup

(

)

const

Returns shared pointer to the main group of the topology.

getName()

string CTopology::getName

(

)

const

Returns topology name.

Exceptions

runtime_error

getRequiredNofAgents() [1/2]

pair< size_t, size_t > CTopology::getRequiredNofAgents

(

size_t

_defaultNumSlots

)

const

Returns required number of agents and slots for the topology as std::pair.

Warning

Limitations: this function might return a wrong results for topologies containing requirements and/or different number of tasks per collection. You might need to play with _defaultNumSlots to get a right result for those cases.

Parameters

[in]

_defaultNumSlots

Default number of slots per agent.

Returns

std::pair of a number of agents (first) and slots (second).

getRequiredNofAgents() [2/2]

size_t CTopology::getRequiredNofAgents

(

)

const

Returns required number of agents and slots for the topology as std::pair.

Warning

This finction is depricated, use std::pair<size_t, size_t> getRequiredNofAgents(size_t _defaultNumSlots) const instead

getRuntimeCollection()

const STopoRuntimeCollection & CTopology::getRuntimeCollection

(

const std::string &

_path

)

const

Returns runtime collection by either ID or runtime path.

Parameters

[in]

_path

Either ID or runtime path.

getRuntimeCollectionById()

const STopoRuntimeCollection & CTopology::getRuntimeCollectionById

(

Id_t

_id

)

const

Returns runtime collection by ID.

Parameters

[in]

_id

Runtime collection ID.

getRuntimeCollectionByIdPath()

const STopoRuntimeCollection & CTopology::getRuntimeCollectionByIdPath

(

const std::string &

_idPath

)

const

Returns runtime collection by path.

Parameters

[in]

_idPath

Runtime collection path in the topology.

getRuntimeCollectionIterator()

STopoRuntimeCollection::FilterIteratorPair_t CTopology::getRuntimeCollectionIterator

(

STopoRuntimeCollection::Condition_t

_condition = nullptr

)

const

Returns runtime collection filter iterator.

Parameters

[in]

_condition

If provided than iterate over collections passed the condition.

getRuntimeCollectionIteratorMatchingPath()

STopoRuntimeCollection::FilterIteratorPair_t CTopology::getRuntimeCollectionIteratorMatchingPath

(

const std::string &

_pathPattern

)

const

Returns runtime collection filter iterator matching the collection path in the topology.

Parameters

[in]

_pathPattern

Regex for collection path in the topology.

getRuntimeTask()

const STopoRuntimeTask & CTopology::getRuntimeTask

(

const std::string &

_path

)

const

Returns runtime task by either ID or runtime path.

Parameters

[in]

_path

Either ID or runtime path.

getRuntimeTaskById()

const STopoRuntimeTask & CTopology::getRuntimeTaskById

(

Id_t

_id

)

const

Returns runtime task by ID.

Parameters

[in]

_id

Runtime task ID.

getRuntimeTaskByIdPath()

const STopoRuntimeTask & CTopology::getRuntimeTaskByIdPath

(

const std::string &

_idPath

)

const

Returns runtime task by path.

Parameters

[in]

_idPath

Runtime task path in the topology.

getRuntimeTaskIterator()

STopoRuntimeTask::FilterIteratorPair_t CTopology::getRuntimeTaskIterator

(

STopoRuntimeTask::Condition_t

_condition = nullptr

)

const

Returns runtime task filter iterator.

Parameters

[in]

_condition

If provided than iterate over tasks passed the condition.

getRuntimeTaskIteratorMatchingPath()

STopoRuntimeTask::FilterIteratorPair_t CTopology::getRuntimeTaskIteratorMatchingPath

(

const std::string &

_pathPattern

)

const

Returns runtime task filter iterator matching the task path in the topology.

Parameters

[in]

_pathPattern

Regex for task path in the topology.

getTotalNofTasks()

size_t CTopology::getTotalNofTasks

(

)

const

Returns total number of tasks in the topology.

---

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

• Topology.h
• Topology.cpp