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. More...
 
 DataFieldIdentifier ()
 Creates an empty DataFieldIdentifier. More...
 
 DataFieldIdentifier (std::string dataFieldIdentifierStr)
 Creates a DataFieldIdentifier from string. More...
 
 DataFieldIdentifier (std::string observerName, std::string channelName, std::string datafieldName)
 Creates a DataFieldIdentifier from string. More...
 
bool equals (const DataFieldIdentifier &dataFieldIdentifier)
 Test two DataFieldIdentifier for equality. More...
 
std::string getChannelName () const
 Retrieve channel name. More...
 
std::string getDataFieldName () const
 Retrieve datafield name. More...
 
std::string getIdentifierStr () const
 Retrieve data field identifier string. More...
 
std::string getObserverName () const
 Retrieve observer name. More...
 

Friends

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

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.

Definition at line 48 of file DataFieldIdentifier.h.

Constructor & Destructor Documentation

◆ DataFieldIdentifier() [1/3]

DataFieldIdentifier ( )
inline

Creates an empty DataFieldIdentifier.

Required for Ice ObjectFactory

Definition at line 55 of file DataFieldIdentifier.h.

◆ DataFieldIdentifier() [2/3]

DataFieldIdentifier ( std::string  dataFieldIdentifierStr)

Creates a DataFieldIdentifier from string.

Parameters
dataFieldIdentifierStrstring in the format "observername.channelname.datafieldname"

Definition at line 33 of file DataFieldIdentifier.cpp.

◆ DataFieldIdentifier() [3/3]

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

Creates a DataFieldIdentifier from string.

Parameters
observerNamename of the observer
channelNamename of the channel
datafieldNamename of the datafield

Definition at line 48 of file DataFieldIdentifier.cpp.

Member Function Documentation

◆ beginsWith()

bool beginsWith ( const DataFieldIdentifier dataFieldIdentifier)

Test if one DataFieldIdentifier contains the other.

Parameters
dataFieldIdentifieridentifier to check for standing at the beginning
Returns
beginsWith

Definition at line 69 of file DataFieldIdentifier.cpp.

+ Here is the call graph for this function:

◆ equals()

bool equals ( const DataFieldIdentifier dataFieldIdentifier)

Test two DataFieldIdentifier for equality.

Parameters
dataFieldIdentifieridentifier to test for equality
Returns
equality

Definition at line 61 of file DataFieldIdentifier.cpp.

+ Here is the call graph for this function:

◆ getChannelName()

std::string getChannelName ( ) const
inline

Retrieve channel name.

Returns
name of the channel

Definition at line 111 of file DataFieldIdentifier.h.

+ Here is the caller graph for this function:

◆ getDataFieldName()

std::string getDataFieldName ( ) const
inline

Retrieve datafield name.

Returns
name of the datafield

Definition at line 121 of file DataFieldIdentifier.h.

+ Here is the caller graph for this function:

◆ getIdentifierStr()

std::string getIdentifierStr ( ) const

Retrieve data field identifier string.

Returns
string which identifies the datafield

Definition at line 56 of file DataFieldIdentifier.cpp.

+ Here is the caller graph for this function:

◆ getObserverName()

std::string getObserverName ( ) const
inline

Retrieve observer name.

Returns
name of the observer

Definition at line 101 of file DataFieldIdentifier.h.

+ Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator<< [1/2]

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

stream operator for DataFieldIdentifier

Definition at line 129 of file DataFieldIdentifier.h.

◆ operator<< [2/2]

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

stream operator for Ice shared pointer of DataFieldIdentifier

Definition at line 138 of file DataFieldIdentifier.h.


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