prmTransformationFixed Class Reference

#include <prmTransformationFixed.h>

Inheritance diagram for prmTransformationFixed:

Public Member Functions
	prmTransformationFixed (void)
	prmTransformationFixed (const std::string &name)
	prmTransformationFixed (const std::string &name, const vctFrm3 &transformation, prmTransformationBasePtr newReference)
	~prmTransformationFixed ()
vctFrm3	WRTReference (void) const
void	SetTransformation (const vctFrm3 &newTransformation)
vctFrm3	GetTransformation (void) const
Public Member Functions inherited from prmTransformationBase
	prmTransformationBase (void)
	prmTransformationBase (const std::string &name)
virtual	~prmTransformationBase ()
	Destructor. The frame is also removed from the frame manager. More...
prmTransformationBasePtr	WorldFrame (void)
bool	SetReferenceFrame (const prmTransformationBasePtr &newReference)
bool	SetReferenceFrame (const std::string &parentName)
prmTransformationBasePtr	GetReferenceFrame (void) const
const std::string &	GetName (void) const
void	SetName (const std::string &name)

Protected Attributes
vctFrm3	Transformation
Protected Attributes inherited from prmTransformationBase
std::string	Name
prmTransformationBasePtr	Parent
NodeListType	Children

Friends
class	prmTransformationManager

Additional Inherited Members
Public Types inherited from prmTransformationBase
typedef std::list < prmTransformationBasePtr >	NodeListType

Detailed Description

Derived Class of prmTransformationBase for a fixed rigid transformation. This class stores an actual frame which can be manually updated if needed.

See Also

prmTransformationBase, prmTransformationDynamic, prmTransformationManager, vctFrm3

Constructor & Destructor Documentation

prmTransformationFixed::prmTransformationFixed ( void  )

inline

Default constructor. Set the frame name as "Undefined", and NULL reference frame, no children.

prmTransformationFixed::prmTransformationFixed ( const std::string &  name )

inline

Constructor with a name only. The frame is automatically added to the frame manager. The transformation between this frame and its reference is set to Identity.

Parameters

name	const std::string describable name

prmTransformationFixed::prmTransformationFixed ( const std::string &  name, const vctFrm3 &  transformation, prmTransformationBasePtr  newReference  )

inline

Constructor with a name, a reference frame and the transformation from the reference frame.

Parameters

name	cost std::string describable name
newTransformation	vctFrm3 const Cartesian frame Transformation prmTransformationBasePtr ptr to attachment point in the transformation manager

prmTransformationFixed::~prmTransformationFixed

(

)

Destructor. The frame is also removed from the frame manager. The children of this frame will inherit its parent when the frame is removed.

Member Function Documentation

vctFrm3 prmTransformationFixed::GetTransformation ( void  ) const

inline

Query the constant transformation

void prmTransformationFixed::SetTransformation ( const vctFrm3 &  newTransformation )

inline

Set transformation between this frame and its reference.

vctFrm3 prmTransformationFixed::WRTReference ( void  ) const

inlinevirtual

Get the transformation between the reference frame and this frame.

Implements prmTransformationBase.

Friends And Related Function Documentation

friend class prmTransformationManager

friend

Member Data Documentation

vctFrm3 prmTransformationFixed::Transformation

protected

a homogenous transform

---

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

• /home/adeguet1/catkin_ws/src/cisst-saw/cisst/cisstParameterTypes/prmTransformationFixed.h