List of all members | Public Member Functions | Static Public Member Functions
ObjectID Class Reference

A known object ID of the form "Dataset/ClassName" or "Dataset/ClassName/InstanceName". More...

#include <RobotAPI/libraries/ArmarXObjects/ObjectID.h>

Public Member Functions

std::string className () const
 
std::string dataset () const
 
bool equalClass (const ObjectID &rhs) const
 Indicates whether dataset and class name are equal. More...
 
ObjectID getClassID () const
 Return just the class ID without an intance name. More...
 
std::string instanceName () const
 
 ObjectID ()
 
 ObjectID (const std::string &dataset, const std::string &className, const std::string &instancName="")
 
 ObjectID (const std::string &nameOrID)
 Construct from either a class name ("myobject") or ID ("mydataset/myobject", "mydataset/myclass/myinstance"). More...
 
bool operator!= (const ObjectID &rhs) const
 
bool operator< (const ObjectID &rhs) const
 
bool operator<= (const ObjectID &rhs) const
 
bool operator== (const ObjectID &rhs) const
 Indicates whether dataset, class name and instance name are equal. More...
 
bool operator> (const ObjectID &rhs) const
 
bool operator>= (const ObjectID &rhs) const
 
void setFromString (const std::string &idString)
 
void setInstanceName (const std::string &instanceName)
 
std::string str () const
 Return "dataset/className" or "dataset/className/instanceName". More...
 
ObjectID withInstanceName (const std::string &instanceName) const
 

Static Public Member Functions

static ObjectID FromString (const std::string &idString)
 Construct from a string produced by str(), e.g. ("mydataset/myobject", "mydataset/myclass/myinstance"). More...
 

Detailed Description

A known object ID of the form "Dataset/ClassName" or "Dataset/ClassName/InstanceName".

Definition at line 11 of file ObjectID.h.

Constructor & Destructor Documentation

◆ ObjectID() [1/3]

ObjectID ( )

Definition at line 9 of file ObjectID.cpp.

+ Here is the caller graph for this function:

◆ ObjectID() [2/3]

ObjectID ( const std::string &  dataset,
const std::string &  className,
const std::string &  instancName = "" 
)

Definition at line 13 of file ObjectID.cpp.

◆ ObjectID() [3/3]

ObjectID ( const std::string &  nameOrID)

Construct from either a class name ("myobject") or ID ("mydataset/myobject", "mydataset/myclass/myinstance").

Definition at line 18 of file ObjectID.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ className()

std::string className ( ) const
inline

Definition at line 28 of file ObjectID.h.

+ Here is the caller graph for this function:

◆ dataset()

std::string dataset ( ) const
inline

Definition at line 24 of file ObjectID.h.

+ Here is the caller graph for this function:

◆ equalClass()

bool equalClass ( const ObjectID &  rhs) const

Indicates whether dataset and class name are equal.

Definition at line 70 of file ObjectID.cpp.

+ Here is the caller graph for this function:

◆ FromString()

ObjectID FromString ( const std::string &  idString)
static

Construct from a string produced by str(), e.g. ("mydataset/myobject", "mydataset/myclass/myinstance").

Definition at line 31 of file ObjectID.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getClassID()

ObjectID getClassID ( ) const

Return just the class ID without an intance name.

Definition at line 65 of file ObjectID.cpp.

+ Here is the call graph for this function:

◆ instanceName()

std::string instanceName ( ) const
inline

Definition at line 32 of file ObjectID.h.

+ Here is the caller graph for this function:

◆ operator!=()

bool operator!= ( const ObjectID &  rhs) const
inline

Definition at line 55 of file ObjectID.h.

+ Here is the call graph for this function:

◆ operator<()

bool operator< ( const ObjectID &  rhs) const

Definition at line 87 of file ObjectID.cpp.

+ Here is the caller graph for this function:

◆ operator<=()

bool operator<= ( const ObjectID &  rhs) const
inline

Definition at line 64 of file ObjectID.h.

+ Here is the call graph for this function:

◆ operator==()

bool operator== ( const ObjectID &  rhs) const

Indicates whether dataset, class name and instance name are equal.

Definition at line 80 of file ObjectID.cpp.

+ Here is the caller graph for this function:

◆ operator>()

bool operator> ( const ObjectID &  rhs) const
inline

Definition at line 60 of file ObjectID.h.

+ Here is the caller graph for this function:

◆ operator>=()

bool operator>= ( const ObjectID &  rhs) const
inline

Definition at line 68 of file ObjectID.h.

+ Here is the call graph for this function:

◆ setFromString()

void setFromString ( const std::string &  idString)

Definition at line 38 of file ObjectID.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setInstanceName()

void setInstanceName ( const std::string &  instanceName)
inline

Definition at line 36 of file ObjectID.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ str()

std::string str ( ) const

Return "dataset/className" or "dataset/className/instanceName".

Definition at line 55 of file ObjectID.cpp.

+ Here is the caller graph for this function:

◆ withInstanceName()

ObjectID withInstanceName ( const std::string &  instanceName) const

Definition at line 75 of file ObjectID.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:
The documentation for this class was generated from the following files: