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.
ObjectID	getClassID () const
	Return just the class ID without an intance name.
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").
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.
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".
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").

Detailed Description

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

Constructor & Destructor Documentation

ObjectID() [1/3]

ObjectID

(

)

ObjectID() [2/3]

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

ObjectID() [3/3]

ObjectID

(

const std::string &

nameOrID

)

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

Member Function Documentation

className()

std::string className ( ) const

inline

dataset()

std::string dataset ( ) const

inline

equalClass()

bool equalClass

(

const ObjectID &

rhs

)

const

Indicates whether dataset and class name are equal.

FromString()

ObjectID FromString ( const std::string & idString )

static

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

getClassID()

ObjectID getClassID

(

)

const

Return just the class ID without an intance name.

instanceName()

std::string instanceName ( ) const

inline

operator!=()

bool operator!= ( const ObjectID & rhs ) const

inline

operator<()

bool operator<

(

const ObjectID &

rhs

)

const

operator<=()

bool operator<= ( const ObjectID & rhs ) const

inline

operator==()

bool operator==

(

const ObjectID &

rhs

)

const

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

operator>()

bool operator> ( const ObjectID & rhs ) const

inline

operator>=()

bool operator>= ( const ObjectID & rhs ) const

inline

setFromString()

void setFromString

(

const std::string &

idString

)

setInstanceName()

void setInstanceName ( const std::string & instanceName )

inline

str()

std::string str

(

)

const

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

withInstanceName()

ObjectID withInstanceName

(

const std::string &

instanceName

)

const

---

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

• RobotAPI/libraries/ArmarXObjects/ObjectID.h
• RobotAPI/libraries/ArmarXObjects/ObjectID.cpp