prmPositionCartesianGet Class Reference

#include <prmPositionCartesianGet.h>

Inheritance diagram for prmPositionCartesianGet:

Public Member Functions
	prmPositionCartesianGet (void)
	prmPositionCartesianGet (const prmPositionCartesianGet &other)
	~prmPositionCartesianGet ()
void	GetMovingFrame (prmTransformationBasePtr &placeHolder) const
void	SetMovingFrame (const prmTransformationBasePtr &newValue)
const prmTransformationBasePtr &	MovingFrame (void) const
prmTransformationBasePtr &	MovingFrame (void)
void	GetReferenceFrame (prmTransformationBasePtr &placeHolder) const
void	SetReferenceFrame (const prmTransformationBasePtr &newValue)
const prmTransformationBasePtr &	ReferenceFrame (void) const
prmTransformationBasePtr &	ReferenceFrame (void)
void	GetPosition (vctFrm3 &placeHolder) const
void	SetPosition (const vctFrm3 &newValue)
const vctFrm3 &	Position (void) const
vctFrm3 &	Position (void)
void	SerializeRaw (std::ostream &outputStream) const
void	DeSerializeRaw (std::istream &inputStream)
void	ToStream (std::ostream &outputStream) const
void	ToStreamRaw (std::ostream &outputStream, const char delimiter= ' ', bool headerOnly=false, const std::string &headerPrefix="") const
void	Copy (const prmPositionCartesianGet &source)
void	SerializeBinary (std::ostream &outputStream) const throw (std::runtime_error)
void	DeSerializeBinary (std::istream &inputStream, const cmnDataFormat &localFormat, const cmnDataFormat &remoteFormat) throw (std::runtime_error)
void	SerializeText (std::ostream &outputStream, const char delimiter= ',') const throw (std::runtime_error)
std::string	SerializeDescription (const char delimiter= ',', const std::string &userDescription="") const
void	DeSerializeText (std::istream &inputStream, const char delimiter= ',') throw (std::runtime_error)
std::string	HumanReadable (void) const
bool	ScalarNumberIsFixed (void) const
size_t	ScalarNumber (void) const
double	Scalar (const size_t index) const throw (std::out_of_range)
std::string	ScalarDescription (const size_t index, const std::string &userDescription="") const throw (std::out_of_range)
Public Member Functions inherited from mtsGenericObject
	mtsGenericObject (void)
	mtsGenericObject (double timestamp, bool automaticTimestamp, bool valid)
	mtsGenericObject (const mtsGenericObject &other)
virtual	~mtsGenericObject (void)
bool	SetTimestampIfAutomatic (double timestamp)
virtual bool	FromStreamRaw (std::istream &inputStream, const char delimiter= ' ')
double	Scalar (const size_t index) const throw (std::out_of_range)
std::string	ScalarDescription (const size_t index, const std::string &userDescription="") const throw (std::out_of_range)
Public Member Functions inherited from cmnGenericObject
virtual	~cmnGenericObject (void)
virtual const cmnClassServicesBase *	Services (void) const =0
bool	ReconstructFrom (const cmnGenericObject &other)
std::string	ToString (void) const
virtual cmnLogger::StreamBufType *	GetLogMultiplexer (void) const
virtual double	Scalar (const size_t CMN_UNUSED(index)) const throw (std::out_of_range)
virtual std::string	ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const

Protected Attributes
prmTransformationBasePtr	mMovingFrame
prmTransformationBasePtr	mReferenceFrame
vctFrm3	mPosition

Constructor & Destructor Documentation

prmPositionCartesianGet::prmPositionCartesianGet

(

void

)

prmPositionCartesianGet::prmPositionCartesianGet

(

const prmPositionCartesianGet &

other

)

prmPositionCartesianGet::~prmPositionCartesianGet

(

)

Member Function Documentation

void prmPositionCartesianGet::Copy

(

const prmPositionCartesianGet &

source

)

void prmPositionCartesianGet::DeSerializeBinary	(	std::istream &	inputStream,
		const cmnDataFormat &	localFormat,
		const cmnDataFormat &	remoteFormat
	)
throw	(	std::runtime_error
	)

void prmPositionCartesianGet::DeSerializeRaw ( std::istream &  inputStream )

virtual

Binary deserialization

Reimplemented from mtsGenericObject.

void prmPositionCartesianGet::DeSerializeText	(	std::istream &	inputStream,
		const char	delimiter = ','
	)
throw	(	std::runtime_error
	)

void prmPositionCartesianGet::GetMovingFrame

(

prmTransformationBasePtr &

placeHolder

)

const

void prmPositionCartesianGet::GetPosition

(

vctFrm3 &

placeHolder

)

const

void prmPositionCartesianGet::GetReferenceFrame

(

prmTransformationBasePtr &

placeHolder

)

const

std::string prmPositionCartesianGet::HumanReadable

(

void

)

const

const prmTransformationBasePtr& prmPositionCartesianGet::MovingFrame

(

void

)

const

prmTransformationBasePtr& prmPositionCartesianGet::MovingFrame

(

void

)

const vctFrm3& prmPositionCartesianGet::Position

(

void

)

const

vctFrm3& prmPositionCartesianGet::Position

(

void

)

const prmTransformationBasePtr& prmPositionCartesianGet::ReferenceFrame

(

void

)

const

prmTransformationBasePtr& prmPositionCartesianGet::ReferenceFrame

(

void

)

double prmPositionCartesianGet::Scalar	(	const size_t	index	)	const
throw	(	std::out_of_range
	)

std::string prmPositionCartesianGet::ScalarDescription	(	const size_t	index,
		const std::string &	userDescription = ""
	)		const
throw	(	std::out_of_range
	)

size_t prmPositionCartesianGet::ScalarNumber ( void  ) const

virtual

Methods for data visualization. Derived classes should override the following methods in order to be properly processed by the data visualizer of the global component manager.

Return a number of data (which can be visualized, i.e., type-casted to double)

Reimplemented from mtsGenericObject.

bool prmPositionCartesianGet::ScalarNumberIsFixed ( void  ) const

virtual

Indicates if this object has a fixed number of scalars. This is used for arrays of object in order to optimize random access for a given scalar. When defining an object with a fixed number of scalars, overloading this method to return true allows some optimizations.

Reimplemented from mtsGenericObject.

void prmPositionCartesianGet::SerializeBinary	(	std::ostream &	outputStream	)	const
throw	(	std::runtime_error
	)

std::string prmPositionCartesianGet::SerializeDescription	(	const char	delimiter = ',',
		const std::string &	userDescription = ""
	)		const

void prmPositionCartesianGet::SerializeRaw ( std::ostream &  outputStream ) const

virtual

Binary serialization

Reimplemented from mtsGenericObject.

void prmPositionCartesianGet::SerializeText	(	std::ostream &	outputStream,
		const char	delimiter = ','
	)		const
throw	(	std::runtime_error
	)

void prmPositionCartesianGet::SetMovingFrame

(

const prmTransformationBasePtr &

newValue

)

void prmPositionCartesianGet::SetPosition

(

const vctFrm3 &

newValue

)

void prmPositionCartesianGet::SetReferenceFrame

(

const prmTransformationBasePtr &

newValue

)

void prmPositionCartesianGet::ToStream ( std::ostream &  outputStream ) const

virtual

Human readable text output. This method only streams the data members of mtsGenericObject, i.e. the Timestamp and Valid flag. It should be called by any derived class re-implementing ToStream.

Reimplemented from mtsGenericObject.

void prmPositionCartesianGet::ToStreamRaw ( std::ostream &  outputStream, const char  delimiter = ' ', bool  headerOnly = false, const std::string &  headerPrefix = ""  ) const

virtual

Raw text output to stream

Reimplemented from mtsGenericObject.

Member Data Documentation

prmTransformationBasePtr prmPositionCartesianGet::mMovingFrame

protected

vctFrm3 prmPositionCartesianGet::mPosition

protected

prmTransformationBasePtr prmPositionCartesianGet::mReferenceFrame

protected

---

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

• /home/adeguet1/catkin_ws/build_release/cisst/include/cisstParameterTypes/prmPositionCartesianGet.h