memoryx::GraphNodeBase

Overview

[ "cpp:virtual" ] class GraphNodeBase extends EntityBase

@brief Represents a directed multigraph's node. The node contains a list of adjacent nodes. A node is assoicated to a scene. If a node can be reached by traversing an outgowing edge it is adjacent.

Used By

GraphNodeBaseList

GraphMemorySegmentBase::addNode

GraphMemorySegmentBase::getNodeById

GraphMemorySegmentBase::getNodeByName

GraphMemorySegmentBase::getNodeFromSceneByName

GraphNodePoseResolverInterface::getNearestNodeToPose

GraphNodePoseResolverInterface::getNearestNodeToPosition

GraphNodePoseResolverInterface::getNearestRobotLocationNode

GraphNodePoseResolverInterface::getNearestRobotLocationNodeId

GraphNodePoseResolverInterface::resolveToGlobalPose

GraphVisualizerInterface::addNode

Operation Index

getPose

@brief Returns the pose of the node.

setPose

@brief Sets the position.

getScene

@brief Returns the scene's name.

setScene

@brief Sets the scene.

getAdjacentNode

@brief Returns an adjacent node.

getAdjacentNodeById

getAdjacentNodes

getOutdegree

@brief Returns the outdegree.

addAdjacentNode

@brief Adds a new adjacent node.

removeAdjacentNode

clearAdjacentNodes

@brief Removes all adjacent nodes.

Operations

::armarx::FramedPoseBase getPose()

@brief Returns the pose of the node.

Return Value

The pose of the node.

void setPose(::armarx::FramedPoseBase pose)

@brief Sets the position.

Parameters

position

The new position.

string getScene()

void setScene(string scene)

EntityRefBase getAdjacentNode(int number) throws ::armarx::IndexOutOfBoundsException

@brief Returns an adjacent node.

Parameters

number

The adjacent node to return.

Return Value

An adjacent node.

EntityRefBase getAdjacentNodeById(string nodeId)

GraphNodeBaseList getAdjacentNodes()

int getOutdegree()

void addAdjacentNode(EntityRefBase newAdjacentNode) throws ::armarx::InvalidTypeException

@brief Adds a new adjacent node. @note If this function is called n times with the same parameter p the graph contains n edges (this,p).

Parameters

newAdjacentNode

The node to add. (It is supposed to reference a GraphNodeBase)

bool removeAdjacentNode(string nodeId) throws ::armarx::InvalidTypeException

void clearAdjacentNodes()