#include <MemoryX/libraries/memorytypes/entity/AgentInstance.h>

Inheritance diagram for AgentInstance:

Public Member Functions
	AgentInstance ()

	AgentInstance (const AgentInstance &source)

	AgentInstance (const std::string &name, const std::string &id="")

AgentInstancePtr	clone (const Ice::Current &c=Ice::emptyCurrent) const

std::string	getAgentFilePath (const ::Ice::Current &c=Ice::emptyCurrent) const override

armarx::FramedOrientationPtr	getOrientation () const

EntityAttributeBasePtr	getOrientationAttribute () const

armarx::FramedPosePtr	getPose () const

armarx::FramedPositionPtr	getPosition () const

EntityAttributeBasePtr	getPositionAttribute () const

armarx::SharedRobotInterfacePrx	getSharedRobot (const Ice::Current &c=Ice::emptyCurrent) const override

std::string	getStringifiedSharedRobotInterfaceProxy (const ::Ice::Current &c=Ice::emptyCurrent) const override

Ice::ObjectPtr	ice_clone () const override

void	setAgentFilePath (const std::string &agentFilePath, const ::Ice::Current &c=Ice::emptyCurrent) override

void	setOrientation (const armarx::FramedOrientationBasePtr &orientation, const ::Ice::Current &=Ice::emptyCurrent) override

void	setPose (const armarx::FramedPoseBasePtr &newPose)

void	setPosition (const armarx::FramedPositionBasePtr &position, const ::Ice::Current &=Ice::emptyCurrent) override

void	setSharedRobot (const armarx::SharedRobotInterfacePrx &robot, const Ice::Current &c=Ice::emptyCurrent) override
	set the proxy to a SharedRobot for this agent.

void	setStringifiedSharedRobotInterfaceProxy (const std::string &stringifiedSharedRobotInterfaceProxy, const ::Ice::Current &c=Ice::emptyCurrent) override

Public Member Functions inherited from Entity
void	__decRef () override

template<typename T>
IceInternal::Handle< T >	addWrapper (T *wrapper)
	Add EntityWrapper to entity.

EntityPtr	clone (const Ice::Current &c=Ice::emptyCurrent) const

void	deserialize (const armarx::ObjectSerializerBasePtr &serializer, const ::Ice::Current &=Ice::emptyCurrent) override
	Subclasses should use serializable attributes and consider these methods final.

bool	equals (const EntityBasePtr &otherEntity, const ::Ice::Current &=Ice::emptyCurrent) const override
	equals computes if two Entity instances are equal.

bool	equalsAttributes (const EntityBasePtr &otherEntity, const ::Ice::Current &=Ice::emptyCurrent) const override
	equalsAttributes computes if two Entity instances are equal.

virtual EntityRefBaseList	getAllParentRefs (bool includeMetaEntities=true) const
	Retrieve all parents by traversing the whole hierarchy.

virtual std::vector< std::string >	getAllParentsAsStringList () const

EntityAttributeBasePtr	getAttribute (const ::std::string &attrName, const ::Ice::Current &=Ice::emptyCurrent) const override
	Retrieve attribute from entity.

memoryx::NameList	getAttributeNames (const ::Ice::Current &=Ice::emptyCurrent) const override
	Retrieve list of all attribute names.

virtual armarx::VariantPtr	getAttributeValue (const ::std::string &attrName) const
	Retrieve value of an attribute from entity.

virtual EntityRefBaseList	getDirectParentRefs () const
	Retrieve parent entity references.

::std::string	getId (const ::Ice::Current &=Ice::emptyCurrent) const override
	Retrieve id of this entity which is an integer in string representation.

::std::string	getName (const ::Ice::Current &=Ice::emptyCurrent) const override
	Retrieve name of this entity.

template<typename T>
IceInternal::Handle< T >	getWrapper ()
	Retrieve EntityWrapper that has previously been added with Entity::addWrapper().

bool	hasAttribute (const ::std::string &attrName, const ::Ice::Current &=Ice::emptyCurrent) const override
	Check whether this entity has an attribute with the given name.

Ice::ObjectPtr	ice_clone () const override

bool	isMetaEntity (const ::Ice::Current &=Ice::emptyCurrent) const override
	Indicates whether this entity only contains meta information.

void	putAttribute (const ::memoryx::EntityAttributeBasePtr &attr, const ::Ice::Current &=Ice::emptyCurrent) override
	Store attribute in entity.

template<typename T>
void	putAttribute (const std::string &attrName, T attrValue, ProbabilityMeasureBasePtr uncertainty=ProbabilityMeasureBasePtr())
	Create and store attribute from name, value, and optionally uncertainty measure.

void	removeAttribute (const ::std::string &attrName, const ::Ice::Current &=Ice::emptyCurrent) override
	Remove attribute with given name from entity.

void	serialize (const armarx::ObjectSerializerBasePtr &serializer, const ::Ice::Current &=Ice::emptyCurrent) const override
	Subclasses should use serializable attributes and consider these methods final.

virtual void	setDirectParentRefs (const EntityRefBaseList &entityRefs)
	Replace parent entity references.

void	setId (const ::std::string &id, const ::Ice::Current &=Ice::emptyCurrent) override
	Set id of this entity.

void	setMetaEntity (bool isMetaEntity, const ::Ice::Current &=Ice::emptyCurrent) override
	Mark this entity as meta (i.e.

void	setName (const ::std::string &name, const ::Ice::Current &=Ice::emptyCurrent) override
	Set name of this entity.

Protected Member Functions
armarx::FramedOrientationBasePtr	getOrientationBase (const ::Ice::Current &=Ice::emptyCurrent) const override

armarx::FramedPoseBasePtr	getPoseBase (const ::Ice::Current &=Ice::emptyCurrent) const override

armarx::FramedPositionBasePtr	getPositionBase (const ::Ice::Current &=Ice::emptyCurrent) const override

Protected Member Functions inherited from Entity
	Entity ()

	Entity (const Entity &source)

void	ice_postUnmarshal () override

void	ice_preMarshal () override

void	output (std::ostream &stream) const

	~Entity () override

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

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

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

Additional Inherited Members
Static Public Member Functions inherited from Entity
static EntityPtr	CreateGenericEntity ()
	Creates an entity without any convenience getter/setter functions.

Protected Attributes inherited from Entity
std::mutex	attributesMutex

std::shared_mutex	entityMutex

AbstractEntityWrapperBaseList	wrappers

std::recursive_mutex	wrappersMutex

Detailed Description

AgentInstance represents an agent (robot) in the working memory. It allows acces to the agent's position and orientation, as well as to a stringified version of the SharedRobotInterfacePrx of that agent, allowing querying of the agents joint values, and the path to the agents XML data file.

Constructor & Destructor Documentation

◆ AgentInstance() [1/3]

AgentInstance ( )

Default AgentInstance constructor.

◆ AgentInstance() [2/3]

AgentInstance ( const AgentInstance & source )

◆ AgentInstance() [3/3]

AgentInstance	(	const std::string &	name,
		const std::string &	id = "" )

Creates an AgentInstance with the given name, and optionally, ID.

Member Function Documentation

◆ clone()

AgentInstancePtr clone ( const Ice::Current & c = Ice::emptyCurrent ) const

◆ getAgentFilePath()

std::string getAgentFilePath ( const ::Ice::Current & c = Ice::emptyCurrent ) const

override

Gets the path of the agents XML data file.

◆ getOrientation()

armarx::FramedOrientationPtr getOrientation ( ) const

Gets the agents framed orientation.

◆ getOrientationAttribute()

EntityAttributeBasePtr getOrientationAttribute ( ) const

Gets a pointer to the agents orientation attribute.

◆ getOrientationBase()

armarx::FramedOrientationBasePtr getOrientationBase ( const ::Ice::Current & = Ice::emptyCurrent ) const

overrideprotected

◆ getPose()

armarx::FramedPosePtr getPose ( ) const

Gets the agents framed pose.

◆ getPoseBase()

armarx::FramedPoseBasePtr getPoseBase ( const ::Ice::Current & = Ice::emptyCurrent ) const

overrideprotected

◆ getPosition()

armarx::FramedPositionPtr getPosition ( ) const

Gets the agents framed position.

◆ getPositionAttribute()

EntityAttributeBasePtr getPositionAttribute ( ) const

Gets a pointer to the agents position attribute.

◆ getPositionBase()

armarx::FramedPositionBasePtr getPositionBase ( const ::Ice::Current & = Ice::emptyCurrent ) const

overrideprotected

◆ getSharedRobot()

armarx::SharedRobotInterfacePrx getSharedRobot ( const Ice::Current & c = Ice::emptyCurrent ) const

override

◆ getStringifiedSharedRobotInterfaceProxy()

std::string getStringifiedSharedRobotInterfaceProxy ( const ::Ice::Current & c = Ice::emptyCurrent ) const

override

Gets the agents SharedRobotInterfacePrx in string format. This can be converted back to proxy format using the ICE communicator.

◆ ice_clone()

Ice::ObjectPtr ice_clone ( ) const

override

◆ setAgentFilePath()

void setAgentFilePath	(	const std::string &	agentFilePath,
		const ::Ice::Current &	c = Ice::emptyCurrent )

override

Sets the path of the agents XML data file.

Parameters

agentFilePath Path of the XML data file.

◆ setOrientation()

void setOrientation	(	const armarx::FramedOrientationBasePtr &	orientation,
		const ::Ice::Current &	= Ice::emptyCurrent )

override

Sets the agents framed orientation.

Parameters

orientation Agents framed orientation.

◆ setPose()

void setPose ( const armarx::FramedPoseBasePtr & newPose )

Sets the agents framed orientation.

Parameters

orientation Agents framed orientation.

◆ setPosition()

void setPosition	(	const armarx::FramedPositionBasePtr &	position,
		const ::Ice::Current &	= Ice::emptyCurrent )

override

Sets the agents framed position.

Parameters

position Agents framed position.

◆ setSharedRobot()

void setSharedRobot	(	const armarx::SharedRobotInterfacePrx &	robot,
		const Ice::Current &	c = Ice::emptyCurrent )

override

set the proxy to a SharedRobot for this agent.

This entity takes the name from the robot in the given proxy

Parameters

robot

◆ setStringifiedSharedRobotInterfaceProxy()

void setStringifiedSharedRobotInterfaceProxy	(	const std::string &	stringifiedSharedRobotInterfaceProxy,
		const ::Ice::Current &	c = Ice::emptyCurrent )

override

Sets the agents SharedRobotInterfacePrx in string format. A proxy can be converted to string format using the ICE communicator.

Friends And Related Symbol Documentation

◆ operator<< [1/3]

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

friend

◆ operator<< [2/3]

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

friend

◆ operator<< [3/3]

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

friend

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

MemoryX/libraries/memorytypes/entity/AgentInstance.h
MemoryX/libraries/memorytypes/entity/AgentInstance.cpp

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AgentInstance() [1/3]

◆ AgentInstance() [2/3]

◆ AgentInstance() [3/3]

Member Function Documentation

◆ clone()

◆ getAgentFilePath()

◆ getOrientation()

◆ getOrientationAttribute()

◆ getOrientationBase()

◆ getPose()

◆ getPoseBase()

◆ getPosition()

◆ getPositionAttribute()

◆ getPositionBase()

◆ getSharedRobot()

◆ getStringifiedSharedRobotInterfaceProxy()

◆ ice_clone()

◆ setAgentFilePath()

◆ setOrientation()

◆ setPose()

◆ setPosition()

◆ setSharedRobot()

◆ setStringifiedSharedRobotInterfaceProxy()

Friends And Related Symbol Documentation

◆ operator<< [1/3]

◆ operator<< [2/3]

◆ operator<< [3/3]