DataFieldIdentifier Class Reference

DataFieldIdentifier provide the basis to identify data field within a distributed ArmarX scenario. More...

#include <ArmarXCore/observers/variant/DataFieldIdentifier.h>

Inheritance diagram for DataFieldIdentifier:

Public Member Functions
bool	beginsWith (const DataFieldIdentifier &dataFieldIdentifier)
	Test if one DataFieldIdentifier contains the other.
	DataFieldIdentifier ()
	Creates an empty DataFieldIdentifier.
	DataFieldIdentifier (std::string dataFieldIdentifierStr)
	Creates a DataFieldIdentifier from string.
	DataFieldIdentifier (std::string observerName, std::string channelName, std::string datafieldName)
	Creates a DataFieldIdentifier from string.
bool	equals (const DataFieldIdentifier &dataFieldIdentifier)
	Test two DataFieldIdentifier for equality.
std::string	getChannelName () const
	Retrieve channel name.
std::string	getDataFieldName () const
	Retrieve datafield name.
std::string	getIdentifierStr () const
	Retrieve data field identifier string.
std::string	getObserverName () const
	Retrieve observer name.

Friends
std::ostream &	operator<< (std::ostream &stream, const DataFieldIdentifier &rhs)
	stream operator for DataFieldIdentifier
std::ostream &	operator<< (std::ostream &stream, const DataFieldIdentifierPtr &rhs)
	stream operator for Ice shared pointer of DataFieldIdentifier

Detailed Description

DataFieldIdentifier provide the basis to identify data field within a distributed ArmarX scenario.

Data fields are provided by observers which again are fed by SensorActor units. An Observer allows defining several condition checks on data fields that generate the events necessary for the robot program (Operation) logic.

Constructor & Destructor Documentation

DataFieldIdentifier() [1/3]

DataFieldIdentifier ( )

inline

Creates an empty DataFieldIdentifier.

Required for Ice ObjectFactory

DataFieldIdentifier() [2/3]

DataFieldIdentifier

(

std::string

dataFieldIdentifierStr

)

Creates a DataFieldIdentifier from string.

Parameters

dataFieldIdentifierStr

string in the format "observername.channelname.datafieldname"

DataFieldIdentifier() [3/3]

DataFieldIdentifier	(	std::string	observerName,
		std::string	channelName,
		std::string	datafieldName )

Creates a DataFieldIdentifier from string.

Parameters

observerName	name of the observer
channelName	name of the channel
datafieldName	name of the datafield

Member Function Documentation

beginsWith()

bool beginsWith

(

const DataFieldIdentifier &

dataFieldIdentifier

)

Test if one DataFieldIdentifier contains the other.

Parameters

dataFieldIdentifier

identifier to check for standing at the beginning

Returns

beginsWith

equals()

bool equals

(

const DataFieldIdentifier &

dataFieldIdentifier

)

Test two DataFieldIdentifier for equality.

Parameters

dataFieldIdentifier

identifier to test for equality

Returns

equality

getChannelName()

std::string getChannelName ( ) const

inline

Retrieve channel name.

Returns

name of the channel

getDataFieldName()

std::string getDataFieldName ( ) const

inline

Retrieve datafield name.

Returns

name of the datafield

getIdentifierStr()

std::string getIdentifierStr

(

)

const

Retrieve data field identifier string.

Returns

string which identifies the datafield

getObserverName()

std::string getObserverName ( ) const

inline

Retrieve observer name.

Returns

name of the observer

Friends And Related Symbol Documentation

operator<< [1/2]

std::ostream & operator<< ( std::ostream & stream, const DataFieldIdentifier & rhs )

friend

stream operator for DataFieldIdentifier

operator<< [2/2]

std::ostream & operator<< ( std::ostream & stream, const DataFieldIdentifierPtr & rhs )

friend

stream operator for Ice shared pointer of DataFieldIdentifier

---

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

• ArmarXCore/observers/variant/DataFieldIdentifier.h
• ArmarXCore/observers/variant/DataFieldIdentifier.cpp