#include <prmBaseFrame.h>

Inheritance diagram for prmBaseFrame:

Public Member Functions
	prmBaseFrame (void)
	prmBaseFrame (const prmBaseFrame &other)
prmBaseFrame &	operator= (const prmBaseFrame &other)
	~prmBaseFrame ()
void	Getreference_frame (std::string &placeHolder) const
std::string	Getreference_frame (void) const
void	Setreference_frame (const std::string &newValue)
const std::string &	reference_frame (void) const
std::string &	reference_frame (void)
void	Gettransform (vctFrm4x4 &placeHolder) const
vctFrm4x4	Gettransform (void) const
void	Settransform (const vctFrm4x4 &newValue)
const vctFrm4x4 &	transform (void) const
vctFrm4x4 &	transform (void)
void	Getcomponent (std::string &placeHolder) const
std::string	Getcomponent (void) const
void	Setcomponent (const std::string &newValue)
const std::string &	component (void) const
std::string &	component (void)
void	Getinterface (std::string &placeHolder) const
std::string	Getinterface (void) const
void	Setinterface (const std::string &newValue)
const std::string &	interface (void) const
std::string &	interface (void)
bool	ValidDefinition (void) const
bool	Fixed (void) const
bool	Dynamic (void) const
void	ApplyTo (const prmStateCartesian &local, prmStateCartesian &withBase) const
void	SerializeRaw (std::ostream &outputStream) const override
void	DeSerializeRaw (std::istream &inputStream) override
void	ToStream (std::ostream &outputStream) const override
void	ToStreamRaw (std::ostream &outputStream, const char delimiter=' ', bool headerOnly=false, const std::string &headerPrefix="") const override
void	Copy (const prmBaseFrame &source)
bool	ScalarNumberIsFixed (void) const override
size_t	ScalarNumber (void) const override
Public Member Functions inherited from mtsGenericObject
	mtsGenericObject (void)
	mtsGenericObject (double timestamp, bool automaticTimestamp, bool valid)
	mtsGenericObject (const mtsGenericObject &other)
virtual	~mtsGenericObject (void)
mtsGenericObject &	operator= (const mtsGenericObject &other)
bool	SetTimestampIfAutomatic (double timestamp)
virtual bool	FromStreamRaw (std::istream &inputStream, const char delimiter=' ')
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 CISST_THROW(std
virtual std::string	ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const

Public Attributes
void SerializeBinary(std::ostream &outputStream) const CISST_THROW(std void DeSerializeBinary(std::istream &inputStream, const cmnDataFormat &localFormat, const cmnDataFormat &remoteFormat) CISST_THROW(std void SerializeText(std::ostream &outputStream, const char delimiter=',') const CISST_THROW(std std::string	SerializeDescription (const char delimiter=',', const std::string &userDescription="") const
void DeSerializeText(std::istream &inputStream, const char delimiter=',') CISST_THROW(std std::string	HumanReadable (void) const

Protected Attributes
std::string	mreference_frame
vctFrm4x4	mtransform
std::string	mcomponent
std::string	minterface

Constructor & Destructor Documentation

◆ prmBaseFrame() [1/2]

prmBaseFrame::prmBaseFrame ( void )

◆ prmBaseFrame() [2/2]

prmBaseFrame::prmBaseFrame ( const prmBaseFrame & other )

◆ ~prmBaseFrame()

prmBaseFrame::~prmBaseFrame ( )

Member Function Documentation

◆ ApplyTo()

void prmBaseFrame::ApplyTo	(	const prmStateCartesian &	local,
		prmStateCartesian &	withBase ) const

inline

◆ component() [1/2]

std::string & prmBaseFrame::component ( void )

◆ component() [2/2]

const std::string & prmBaseFrame::component ( void ) const

◆ Copy()

void prmBaseFrame::Copy ( const prmBaseFrame & source )

◆ DeSerializeRaw()

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

overridevirtual

Binary deserialization

Reimplemented from mtsGenericObject.

◆ Dynamic()

bool prmBaseFrame::Dynamic ( void ) const

inline

◆ Fixed()

bool prmBaseFrame::Fixed ( void ) const

inline

◆ Getcomponent() [1/2]

void prmBaseFrame::Getcomponent ( std::string & placeHolder ) const

◆ Getcomponent() [2/2]

std::string prmBaseFrame::Getcomponent ( void ) const

inline

◆ Getinterface() [1/2]

void prmBaseFrame::Getinterface ( std::string & placeHolder ) const

◆ Getinterface() [2/2]

std::string prmBaseFrame::Getinterface ( void ) const

inline

◆ Getreference_frame() [1/2]

void prmBaseFrame::Getreference_frame ( std::string & placeHolder ) const

◆ Getreference_frame() [2/2]

std::string prmBaseFrame::Getreference_frame ( void ) const

inline

◆ Gettransform() [1/2]

void prmBaseFrame::Gettransform ( vctFrm4x4 & placeHolder ) const

◆ Gettransform() [2/2]

vctFrm4x4 prmBaseFrame::Gettransform ( void ) const

inline

◆ interface() [1/2]

std::string & prmBaseFrame::interface ( void )

◆ interface() [2/2]

const std::string & prmBaseFrame::interface ( void ) const

◆ operator=()

prmBaseFrame & prmBaseFrame::operator= ( const prmBaseFrame & other )

◆ reference_frame() [1/2]

std::string & prmBaseFrame::reference_frame ( void )

◆ reference_frame() [2/2]

const std::string & prmBaseFrame::reference_frame ( void ) const

◆ ScalarNumber()

size_t prmBaseFrame::ScalarNumber ( void ) const

overridevirtual

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.

◆ ScalarNumberIsFixed()

bool prmBaseFrame::ScalarNumberIsFixed ( void ) const

overridevirtual

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.

◆ SerializeRaw()

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

overridevirtual

Binary serialization

Reimplemented from mtsGenericObject.

◆ Setcomponent()

void prmBaseFrame::Setcomponent ( const std::string & newValue )

◆ Setinterface()

void prmBaseFrame::Setinterface ( const std::string & newValue )

◆ Setreference_frame()

void prmBaseFrame::Setreference_frame ( const std::string & newValue )

◆ Settransform()

void prmBaseFrame::Settransform ( const vctFrm4x4 & newValue )

◆ ToStream()

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

overridevirtual

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.

◆ ToStreamRaw()

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

overridevirtual

Raw text output to stream

Reimplemented from mtsGenericObject.

◆ transform() [1/2]

vctFrm4x4 & prmBaseFrame::transform ( void )

◆ transform() [2/2]

const vctFrm4x4 & prmBaseFrame::transform ( void ) const

◆ ValidDefinition()

bool prmBaseFrame::ValidDefinition ( void ) const

inline

Member Data Documentation

◆ HumanReadable

void DeSerializeText(std::istream &inputStream, const char delimiter=',') CISST_THROW(std std::string prmBaseFrame::HumanReadable(void) const

◆ mcomponent

std::string prmBaseFrame::mcomponent

protected

◆ minterface

std::string prmBaseFrame::minterface

protected

◆ mreference_frame

std::string prmBaseFrame::mreference_frame

protected

◆ mtransform

vctFrm4x4 prmBaseFrame::mtransform

protected

◆ SerializeDescription

void SerializeBinary(std::ostream &outputStream) const CISST_THROW(std void DeSerializeBinary(std::istream &inputStream, const cmnDataFormat &localFormat, const cmnDataFormat &remoteFormat) CISST_THROW(std void SerializeText(std::ostream &outputStream, const char delimiter=',') const CISST_THROW(std std::string prmBaseFrame::SerializeDescription(const char delimiter=',', const std::string &userDescription="") const

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

tmp/cisst-saw/build/cisst/include/cisstParameterTypes/prmBaseFrame.h

Public Member Functions

Public Attributes

Protected Attributes

Constructor & Destructor Documentation

◆ prmBaseFrame() [1/2]

◆ prmBaseFrame() [2/2]

◆ ~prmBaseFrame()

Member Function Documentation

◆ ApplyTo()

◆ component() [1/2]

◆ component() [2/2]

◆ Copy()

◆ DeSerializeRaw()

◆ Dynamic()

◆ Fixed()

◆ Getcomponent() [1/2]

◆ Getcomponent() [2/2]

◆ Getinterface() [1/2]

◆ Getinterface() [2/2]

◆ Getreference_frame() [1/2]

◆ Getreference_frame() [2/2]

◆ Gettransform() [1/2]

◆ Gettransform() [2/2]

◆ interface() [1/2]

◆ interface() [2/2]

◆ operator=()

◆ reference_frame() [1/2]

◆ reference_frame() [2/2]

◆ ScalarNumber()

◆ ScalarNumberIsFixed()

◆ SerializeRaw()

◆ Setcomponent()

◆ Setinterface()

◆ Setreference_frame()

◆ Settransform()

◆ ToStream()

◆ ToStreamRaw()

◆ transform() [1/2]

◆ transform() [2/2]

◆ ValidDefinition()

Member Data Documentation

◆ HumanReadable

◆ mcomponent

◆ minterface

◆ mreference_frame

◆ mtransform

◆ SerializeDescription