prmStateJoint Class Reference

#include <prmStateJoint.h>

Inheritance diagram for prmStateJoint:

Public Member Functions
	prmStateJoint (void)
	prmStateJoint (const prmStateJoint &other)
	~prmStateJoint ()
void	GetName (vctDynamicVector< std::string > &placeHolder) const
void	SetName (const vctDynamicVector< std::string > &newValue)
const vctDynamicVector < std::string > &	Name (void) const
vctDynamicVector< std::string > &	Name (void)
void	GetPosition (vctDynamicVector< double > &placeHolder) const
void	SetPosition (const vctDynamicVector< double > &newValue)
const vctDynamicVector< double > &	Position (void) const
vctDynamicVector< double > &	Position (void)
void	GetVelocity (vctDynamicVector< double > &placeHolder) const
void	SetVelocity (const vctDynamicVector< double > &newValue)
const vctDynamicVector< double > &	Velocity (void) const
vctDynamicVector< double > &	Velocity (void)
void	GetEffort (vctDynamicVector< double > &placeHolder) const
void	SetEffort (const vctDynamicVector< double > &newValue)
const vctDynamicVector< double > &	Effort (void) const
vctDynamicVector< double > &	Effort (void)
void	SetSize (const size_t &size)
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 prmStateJoint &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
vctDynamicVector< std::string >	mName
vctDynamicVector< double >	mPosition
vctDynamicVector< double >	mVelocity
vctDynamicVector< double >	mEffort

Constructor & Destructor Documentation

prmStateJoint::prmStateJoint

(

void

)

prmStateJoint::prmStateJoint

(

const prmStateJoint &

other

)

prmStateJoint::~prmStateJoint

(

)

Member Function Documentation

void prmStateJoint::Copy

(

const prmStateJoint &

source

)

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

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

virtual

Binary deserialization

Reimplemented from mtsGenericObject.

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

const vctDynamicVector<double>& prmStateJoint::Effort

(

void

)

const

vctDynamicVector<double>& prmStateJoint::Effort

(

void

)

void prmStateJoint::GetEffort

(

vctDynamicVector< double > &

placeHolder

)

const

void prmStateJoint::GetName

(

vctDynamicVector< std::string > &

placeHolder

)

const

void prmStateJoint::GetPosition

(

vctDynamicVector< double > &

placeHolder

)

const

void prmStateJoint::GetVelocity

(

vctDynamicVector< double > &

placeHolder

)

const

std::string prmStateJoint::HumanReadable

(

void

)

const

const vctDynamicVector<std::string>& prmStateJoint::Name

(

void

)

const

vctDynamicVector<std::string>& prmStateJoint::Name

(

void

)

const vctDynamicVector<double>& prmStateJoint::Position

(

void

)

const

vctDynamicVector<double>& prmStateJoint::Position

(

void

)

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

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

size_t prmStateJoint::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 prmStateJoint::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 prmStateJoint::SerializeBinary	(	std::ostream &	outputStream	)	const
throw	(	std::runtime_error
	)

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

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

virtual

Binary serialization

Reimplemented from mtsGenericObject.

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

void prmStateJoint::SetEffort

(

const vctDynamicVector< double > &

newValue

)

void prmStateJoint::SetName

(

const vctDynamicVector< std::string > &

newValue

)

void prmStateJoint::SetPosition

(

const vctDynamicVector< double > &

newValue

)

void prmStateJoint::SetSize ( const size_t &  size )

inline

void prmStateJoint::SetVelocity

(

const vctDynamicVector< double > &

newValue

)

void prmStateJoint::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 prmStateJoint::ToStreamRaw ( std::ostream &  outputStream, const char  delimiter = ' ', bool  headerOnly = false, const std::string &  headerPrefix = ""  ) const

virtual

Raw text output to stream

Reimplemented from mtsGenericObject.

const vctDynamicVector<double>& prmStateJoint::Velocity

(

void

)

const

vctDynamicVector<double>& prmStateJoint::Velocity

(

void

)

Member Data Documentation

vctDynamicVector<double> prmStateJoint::mEffort

protected

vctDynamicVector<std::string> prmStateJoint::mName

protected

vctDynamicVector<double> prmStateJoint::mPosition

protected

vctDynamicVector<double> prmStateJoint::mVelocity

protected

---

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

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