se2ez::FrameMap Class Reference

Map of frame name to a pair of that describes if the transform is "dirty" (needs updating) and its current transform. More...

#include <robot.h>

Classes
struct	Value
	A tuple that stores whether a transform is dirty (needs to be updated), the transform itself, and the transforms of the geometry associated with the frame. More...

Public Member Functions
void	dirty ()
	Dirties all frames within the frame map. More...
std::string	printFrames (const RobotPtr &robot) const
	Prints out all current frame pose information. Attaches "_[ x, y, t ]" to the Robot::printTree(), where '_' is 'C' for clean, 'D' for dirty, and 'X' for uninitialized. "[ x, y, t ]" is the transform of the frame. More...
Constructors
	FrameMap (const Robot &robot)
	Constructor. More...
	FrameMap (const RobotPtr &robot)
	Constructor. More...
	FrameMap (const FrameMap &)=delete
	FrameMap (FrameMap &&)=delete
Entry Manipulation
void	insert (FrameMapPtr other)
	Inserts all entries in this frame map into another frame map. More...
Value &	getEntry (const std::string &frame_name)
	Gets the entry in the frame map associated with frame_name. Creates the entry if one does not already exist. More...
const Value &	getEntryConst (const std::string &frame_name) const
	Gets the entry in the frame map associated with frame_name. Throws error if it does not already exist. More...

Private Attributes
tf::EigenHash< std::string, Value >	frames
	Map of frame name to dirty / transform pairs. More...

Detailed Description

Map of frame name to a pair of that describes if the transform is "dirty" (needs updating) and its current transform.

Definition at line 39 of file robot.h.

Constructor & Destructor Documentation

FrameMap() [1/4]

FrameMap::FrameMap

(

const Robot &

robot

)

Constructor.

Parameters

[in]

robot

Robot that this is a frame map for.

FrameMap

Definition at line 17 of file robot.cpp.

FrameMap() [2/4]

FrameMap::FrameMap

(

const RobotPtr &

robot

)

Constructor.

Parameters

[in]

robot

Robot that this is a frame map for.

Definition at line 22 of file robot.cpp.

FrameMap() [3/4]

se2ez::FrameMap::FrameMap ( const FrameMap &  )

delete

FrameMap() [4/4]

se2ez::FrameMap::FrameMap ( FrameMap &&  )

delete

Member Function Documentation

dirty()

void FrameMap::dirty

(

)

Dirties all frames within the frame map.

Definition at line 27 of file robot.cpp.

getEntry()

FrameMap::Value & FrameMap::getEntry

(

const std::string &

frame_name

)

Gets the entry in the frame map associated with frame_name. Creates the entry if one does not already exist.

Parameters

[in]

frame_name

Name of frame to get entry for.

Returns

Entry associated with frame.

Definition at line 42 of file robot.cpp.

getEntryConst()

const FrameMap::Value & FrameMap::getEntryConst

(

const std::string &

frame_name

)

const

Gets the entry in the frame map associated with frame_name. Throws error if it does not already exist.

Parameters

[in]

frame_name

Name of frame to get entry for.

Returns

Entry associated with frame.

Definition at line 48 of file robot.cpp.

insert()

void FrameMap::insert

(

FrameMapPtr

other

)

Inserts all entries in this frame map into another frame map.

Parameters

[out]

other

Other frame map to insert entries into.

Definition at line 36 of file robot.cpp.

printFrames()

std::string FrameMap::printFrames

(

const RobotPtr &

robot

)

const

Prints out all current frame pose information. Attaches "_[ x, y, t ]" to the Robot::printTree(), where '_' is 'C' for clean, 'D' for dirty, and 'X' for uninitialized. "[ x, y, t ]" is the transform of the frame.

Parameters

[in]

robot

Robot that this frame map is associated with.

Returns

Printed tree with frame information.

Definition at line 57 of file robot.cpp.

Member Data Documentation

frames

tf::EigenHash<std::string, Value> se2ez::FrameMap::frames

private

Map of frame name to dirty / transform pairs.

Definition at line 114 of file robot.h.

---

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

• /home/zak/code/se2ez_work/include/se2ez/core/robot.h
• /home/zak/code/se2ez_work/src/core/robot.cpp