GraphNode Class Reference

Implementation of the ice interface GraphNodeBase. More...

#include <MemoryX/libraries/memorytypes/variants/GraphNode/GraphNode.h>

+ Inheritance diagram for GraphNode:

Public Member Functions

void addAdjacentNode (const ::memoryx::EntityRefBasePtr &newAdjacentNode, const ::Ice::Current &c=Ice::emptyCurrent) override
 
void clearAdjacentNodes (const ::Ice::Current &=Ice::emptyCurrent) override
 
GraphNodePtr clone (const Ice::Current &=Ice::emptyCurrent) const
 
::memoryx::EntityRefBasePtr getAdjacentNode (::Ice::Int i, const ::Ice::Current &=Ice::emptyCurrent) override
 
::memoryx::EntityRefBasePtr getAdjacentNodeById (const std::string &nodeId, const Ice::Current &c=Ice::emptyCurrent) override
 
memoryx::GraphNodeBaseList getAdjacentNodes (const Ice::Current &c=Ice::emptyCurrent) override
 
int getOutdegree (const ::Ice::Current &=Ice::emptyCurrent) const override
 
::armarx::FramedPoseBasePtr getPose (const ::Ice::Current &=Ice::emptyCurrent) const override
 
::std::string getScene (const ::Ice::Current &=Ice::emptyCurrent) const override
 
float getYawAngle () const
 
 GraphNode (const ::armarx::FramedPoseBasePtr pose, const std::string &nodeName, const std::string &scene)
 
 GraphNode (float x, float y, float alpha, const std::string &nodeName, const std::string &scene)
 Convenience constructor for 2D pose with orientation and global frame. More...
 
Ice::ObjectPtr ice_clone () const override
 
bool removeAdjacentNode (const std::string &nodeId, const Ice::Current &) override
 
void setPose (const ::armarx::FramedPoseBasePtr &pose, const ::Ice::Current &=Ice::emptyCurrent) override
 
void setScene (const std::string &scene, const ::Ice::Current &=Ice::emptyCurrent) override
 
 ~GraphNode () override
 
- Public Member Functions inherited from Entity
void __decRef () override
 
template<typename T >
IceInternal::Handle< TaddWrapper (T *wrapper)
 Add EntityWrapper to entity. More...
 
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. More...
 
bool equals (const EntityBasePtr &otherEntity, const ::Ice::Current &=Ice::emptyCurrent) const override
 equals computes if two Entity instances are equal. More...
 
bool equalsAttributes (const EntityBasePtr &otherEntity, const ::Ice::Current &=Ice::emptyCurrent) const override
 equalsAttributes computes if two Entity instances are equal. More...
 
virtual EntityRefBaseList getAllParentRefs (bool includeMetaEntities=true) const
 Retrieve all parents by traversing the whole hierarchy. More...
 
virtual std::vector< std::string > getAllParentsAsStringList () const
 
EntityAttributeBasePtr getAttribute (const ::std::string &attrName, const ::Ice::Current &=Ice::emptyCurrent) const override
 Retrieve attribute from entity. More...
 
memoryx::NameList getAttributeNames (const ::Ice::Current &=Ice::emptyCurrent) const override
 Retrieve list of all attribute names. More...
 
virtual armarx::VariantPtr getAttributeValue (const ::std::string &attrName) const
 Retrieve value of an attribute from entity. More...
 
virtual EntityRefBaseList getDirectParentRefs () const
 Retrieve parent entity references. More...
 
::std::string getId (const ::Ice::Current &=Ice::emptyCurrent) const override
 Retrieve id of this entity which is an integer in string representation. More...
 
::std::string getName (const ::Ice::Current &=Ice::emptyCurrent) const override
 Retrieve name of this entity. More...
 
template<typename T >
IceInternal::Handle< TgetWrapper ()
 Retrieve EntityWrapper that has previously been added with Entity::addWrapper(). More...
 
bool hasAttribute (const ::std::string &attrName, const ::Ice::Current &=Ice::emptyCurrent) const override
 Check whether this entity has an attribute with the given name. More...
 
Ice::ObjectPtr ice_clone () const override
 
bool isMetaEntity (const ::Ice::Current &=Ice::emptyCurrent) const override
 Indicates whether this entity only contains meta information. More...
 
void putAttribute (const ::memoryx::EntityAttributeBasePtr &attr, const ::Ice::Current &=Ice::emptyCurrent) override
 Store attribute in entity. More...
 
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. More...
 
void removeAttribute (const ::std::string &attrName, const ::Ice::Current &=Ice::emptyCurrent) override
 Remove attribute with given name from entity. More...
 
void serialize (const armarx::ObjectSerializerBasePtr &serializer, const ::Ice::Current &=Ice::emptyCurrent) const override
 Subclasses should use serializable attributes and consider these methods final. More...
 
virtual void setDirectParentRefs (const EntityRefBaseList &entityRefs)
 Replace parent entity references. More...
 
void setId (const ::std::string &id, const ::Ice::Current &=Ice::emptyCurrent) override
 Set id of this entity. More...
 
void setMetaEntity (bool isMetaEntity, const ::Ice::Current &=Ice::emptyCurrent) override
 Mark this entity as meta (i.e. More...
 
void setName (const ::std::string &name, const ::Ice::Current &=Ice::emptyCurrent) override
 Set name of this entity. More...
 

Static Public Attributes

static const std::string GRAPH_NODE_ATTR_SCENE
 

Friends

template<class IceBaseClass , class DerivedClass >
class armarx::GenericFactory
 

Additional Inherited Members

- Static Public Member Functions inherited from Entity
static EntityPtr CreateGenericEntity ()
 Creates an entity without any convenience getter/setter functions. More...
 
- 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
 
- Protected Attributes inherited from Entity
std::mutex attributesMutex
 
std::shared_mutex entityMutex
 
AbstractEntityWrapperBaseList wrappers
 
std::recursive_mutex wrappersMutex
 

Detailed Description

Implementation of the ice interface GraphNodeBase.

Definition at line 50 of file GraphNode.h.

Constructor & Destructor Documentation

◆ GraphNode() [1/2]

GraphNode ( const ::armarx::FramedPoseBasePtr  pose,
const std::string &  nodeName,
const std::string &  scene 
)

◆ GraphNode() [2/2]

GraphNode ( float  x,
float  y,
float  alpha,
const std::string &  nodeName,
const std::string &  scene 
)

Convenience constructor for 2D pose with orientation and global frame.

z, roll and pitch will be zero.

Parameters
xX coordinate value
yY coordinate value
alphaRotation around z axis
nodeNamename of this node
sceneName of the scene

Definition at line 46 of file GraphNode.cpp.

◆ ~GraphNode()

~GraphNode ( )
override

Definition at line 74 of file GraphNode.cpp.

Member Function Documentation

◆ addAdjacentNode()

void addAdjacentNode ( const ::memoryx::EntityRefBasePtr &  newAdjacentNode,
const ::Ice::Current &  c = Ice::emptyCurrent 
)
override

Definition at line 145 of file GraphNode.cpp.

+ Here is the call graph for this function:

◆ clearAdjacentNodes()

void clearAdjacentNodes ( const ::Ice::Current &  = Ice::emptyCurrent)
override

Definition at line 161 of file GraphNode.cpp.

◆ clone()

memoryx::GraphNodePtr clone ( const Ice::Current &  = Ice::emptyCurrent) const

Definition at line 193 of file GraphNode.cpp.

◆ getAdjacentNode()

memoryx::EntityRefBasePtr getAdjacentNode ( ::Ice::Int  i,
const ::Ice::Current &  = Ice::emptyCurrent 
)
override

Definition at line 103 of file GraphNode.cpp.

+ Here is the call graph for this function:

◆ getAdjacentNodeById()

memoryx::EntityRefBasePtr getAdjacentNodeById ( const std::string &  nodeId,
const Ice::Current &  c = Ice::emptyCurrent 
)
override

Definition at line 117 of file GraphNode.cpp.

◆ getAdjacentNodes()

memoryx::GraphNodeBaseList getAdjacentNodes ( const Ice::Current &  c = Ice::emptyCurrent)
override

Definition at line 131 of file GraphNode.cpp.

◆ getOutdegree()

int getOutdegree ( const ::Ice::Current &  = Ice::emptyCurrent) const
override

Definition at line 98 of file GraphNode.cpp.

◆ getPose()

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

Definition at line 78 of file GraphNode.cpp.

◆ getScene()

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

Definition at line 88 of file GraphNode.cpp.

◆ getYawAngle()

float getYawAngle ( ) const

Definition at line 181 of file GraphNode.cpp.

◆ ice_clone()

Ice::ObjectPtr ice_clone ( ) const
override

Definition at line 188 of file GraphNode.cpp.

◆ removeAdjacentNode()

bool removeAdjacentNode ( const std::string &  nodeId,
const Ice::Current &   
)
override

Definition at line 166 of file GraphNode.cpp.

◆ setPose()

void setPose ( const ::armarx::FramedPoseBasePtr &  pose,
const ::Ice::Current &  = Ice::emptyCurrent 
)
override

Definition at line 83 of file GraphNode.cpp.

◆ setScene()

void setScene ( const std::string &  scene,
const ::Ice::Current &  = Ice::emptyCurrent 
)
override

Definition at line 93 of file GraphNode.cpp.

Friends And Related Function Documentation

◆ armarx::GenericFactory

friend class armarx::GenericFactory
friend

Definition at line 55 of file GraphNode.h.

Field Documentation

◆ GRAPH_NODE_ATTR_SCENE

const std::string GRAPH_NODE_ATTR_SCENE
static
Initial value:
{
"scene"
}

Definition at line 59 of file GraphNode.h.


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