prmFixtureGainCartesianSet Class Reference

#include <prmFixtureGainCartesianSet.h>

Inheritance diagram for prmFixtureGainCartesianSet:

Public Member Functions
	prmFixtureGainCartesianSet (void)
	prmFixtureGainCartesianSet (const prmFixtureGainCartesianSet &other)
	~prmFixtureGainCartesianSet ()
void	GetForceOrientation (vctMatRot3 &placeHolder) const
void	SetForceOrientation (const vctMatRot3 &newValue)
const vctMatRot3 &	ForceOrientation (void) const
vctMatRot3 &	ForceOrientation (void)
void	GetForcePosition (vct3 &placeHolder) const
void	SetForcePosition (const vct3 &newValue)
const vct3 &	ForcePosition (void) const
vct3 &	ForcePosition (void)
void	GetTorqueOrientation (vctMatRot3 &placeHolder) const
void	SetTorqueOrientation (const vctMatRot3 &newValue)
const vctMatRot3 &	TorqueOrientation (void) const
vctMatRot3 &	TorqueOrientation (void)
void	GetPositionStiffnessPos (vct3 &placeHolder) const
void	SetPositionStiffnessPos (const vct3 &newValue)
const vct3 &	PositionStiffnessPos (void) const
vct3 &	PositionStiffnessPos (void)
void	GetPositionStiffnessNeg (vct3 &placeHolder) const
void	SetPositionStiffnessNeg (const vct3 &newValue)
const vct3 &	PositionStiffnessNeg (void) const
vct3 &	PositionStiffnessNeg (void)
void	GetPositionDampingPos (vct3 &placeHolder) const
void	SetPositionDampingPos (const vct3 &newValue)
const vct3 &	PositionDampingPos (void) const
vct3 &	PositionDampingPos (void)
void	GetPositionDampingNeg (vct3 &placeHolder) const
void	SetPositionDampingNeg (const vct3 &newValue)
const vct3 &	PositionDampingNeg (void) const
vct3 &	PositionDampingNeg (void)
void	GetForceBiasPos (vct3 &placeHolder) const
void	SetForceBiasPos (const vct3 &newValue)
const vct3 &	ForceBiasPos (void) const
vct3 &	ForceBiasPos (void)
void	GetForceBiasNeg (vct3 &placeHolder) const
void	SetForceBiasNeg (const vct3 &newValue)
const vct3 &	ForceBiasNeg (void) const
vct3 &	ForceBiasNeg (void)
void	GetOrientationStiffnessPos (vct3 &placeHolder) const
void	SetOrientationStiffnessPos (const vct3 &newValue)
const vct3 &	OrientationStiffnessPos (void) const
vct3 &	OrientationStiffnessPos (void)
void	GetOrientationStiffnessNeg (vct3 &placeHolder) const
void	SetOrientationStiffnessNeg (const vct3 &newValue)
const vct3 &	OrientationStiffnessNeg (void) const
vct3 &	OrientationStiffnessNeg (void)
void	GetOrientationDampingPos (vct3 &placeHolder) const
void	SetOrientationDampingPos (const vct3 &newValue)
const vct3 &	OrientationDampingPos (void) const
vct3 &	OrientationDampingPos (void)
void	GetOrientationDampingNeg (vct3 &placeHolder) const
void	SetOrientationDampingNeg (const vct3 &newValue)
const vct3 &	OrientationDampingNeg (void) const
vct3 &	OrientationDampingNeg (void)
void	GetTorqueBiasPos (vct3 &placeHolder) const
void	SetTorqueBiasPos (const vct3 &newValue)
const vct3 &	TorqueBiasPos (void) const
vct3 &	TorqueBiasPos (void)
void	GetTorqueBiasNeg (vct3 &placeHolder) const
void	SetTorqueBiasNeg (const vct3 &newValue)
const vct3 &	TorqueBiasNeg (void) const
vct3 &	TorqueBiasNeg (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 prmFixtureGainCartesianSet &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
vctMatRot3	mForceOrientation
vct3	mForcePosition
vctMatRot3	mTorqueOrientation
vct3	mPositionStiffnessPos
vct3	mPositionStiffnessNeg
vct3	mPositionDampingPos
vct3	mPositionDampingNeg
vct3	mForceBiasPos
vct3	mForceBiasNeg
vct3	mOrientationStiffnessPos
vct3	mOrientationStiffnessNeg
vct3	mOrientationDampingPos
vct3	mOrientationDampingNeg
vct3	mTorqueBiasPos
vct3	mTorqueBiasNeg

Constructor & Destructor Documentation

prmFixtureGainCartesianSet::prmFixtureGainCartesianSet

(

void

)

prmFixtureGainCartesianSet::prmFixtureGainCartesianSet

(

const prmFixtureGainCartesianSet &

other

)

prmFixtureGainCartesianSet::~prmFixtureGainCartesianSet

(

)

Member Function Documentation

void prmFixtureGainCartesianSet::Copy

(

const prmFixtureGainCartesianSet &

source

)

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

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

virtual

Binary deserialization

Reimplemented from mtsGenericObject.

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

const vct3& prmFixtureGainCartesianSet::ForceBiasNeg

(

void

)

const

vct3& prmFixtureGainCartesianSet::ForceBiasNeg

(

void

)

const vct3& prmFixtureGainCartesianSet::ForceBiasPos

(

void

)

const

vct3& prmFixtureGainCartesianSet::ForceBiasPos

(

void

)

const vctMatRot3& prmFixtureGainCartesianSet::ForceOrientation

(

void

)

const

vctMatRot3& prmFixtureGainCartesianSet::ForceOrientation

(

void

)

const vct3& prmFixtureGainCartesianSet::ForcePosition

(

void

)

const

vct3& prmFixtureGainCartesianSet::ForcePosition

(

void

)

void prmFixtureGainCartesianSet::GetForceBiasNeg

(

vct3 &

placeHolder

)

const

void prmFixtureGainCartesianSet::GetForceBiasPos

(

vct3 &

placeHolder

)

const

void prmFixtureGainCartesianSet::GetForceOrientation

(

vctMatRot3 &

placeHolder

)

const

void prmFixtureGainCartesianSet::GetForcePosition

(

vct3 &

placeHolder

)

const

void prmFixtureGainCartesianSet::GetOrientationDampingNeg

(

vct3 &

placeHolder

)

const

void prmFixtureGainCartesianSet::GetOrientationDampingPos

(

vct3 &

placeHolder

)

const

void prmFixtureGainCartesianSet::GetOrientationStiffnessNeg

(

vct3 &

placeHolder

)

const

void prmFixtureGainCartesianSet::GetOrientationStiffnessPos

(

vct3 &

placeHolder

)

const

void prmFixtureGainCartesianSet::GetPositionDampingNeg

(

vct3 &

placeHolder

)

const

void prmFixtureGainCartesianSet::GetPositionDampingPos

(

vct3 &

placeHolder

)

const

void prmFixtureGainCartesianSet::GetPositionStiffnessNeg

(

vct3 &

placeHolder

)

const

void prmFixtureGainCartesianSet::GetPositionStiffnessPos

(

vct3 &

placeHolder

)

const

void prmFixtureGainCartesianSet::GetTorqueBiasNeg

(

vct3 &

placeHolder

)

const

void prmFixtureGainCartesianSet::GetTorqueBiasPos

(

vct3 &

placeHolder

)

const

void prmFixtureGainCartesianSet::GetTorqueOrientation

(

vctMatRot3 &

placeHolder

)

const

std::string prmFixtureGainCartesianSet::HumanReadable

(

void

)

const

const vct3& prmFixtureGainCartesianSet::OrientationDampingNeg

(

void

)

const

vct3& prmFixtureGainCartesianSet::OrientationDampingNeg

(

void

)

const vct3& prmFixtureGainCartesianSet::OrientationDampingPos

(

void

)

const

vct3& prmFixtureGainCartesianSet::OrientationDampingPos

(

void

)

const vct3& prmFixtureGainCartesianSet::OrientationStiffnessNeg

(

void

)

const

vct3& prmFixtureGainCartesianSet::OrientationStiffnessNeg

(

void

)

const vct3& prmFixtureGainCartesianSet::OrientationStiffnessPos

(

void

)

const

vct3& prmFixtureGainCartesianSet::OrientationStiffnessPos

(

void

)

const vct3& prmFixtureGainCartesianSet::PositionDampingNeg

(

void

)

const

vct3& prmFixtureGainCartesianSet::PositionDampingNeg

(

void

)

const vct3& prmFixtureGainCartesianSet::PositionDampingPos

(

void

)

const

vct3& prmFixtureGainCartesianSet::PositionDampingPos

(

void

)

const vct3& prmFixtureGainCartesianSet::PositionStiffnessNeg

(

void

)

const

vct3& prmFixtureGainCartesianSet::PositionStiffnessNeg

(

void

)

const vct3& prmFixtureGainCartesianSet::PositionStiffnessPos

(

void

)

const

vct3& prmFixtureGainCartesianSet::PositionStiffnessPos

(

void

)

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

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

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

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

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

virtual

Binary serialization

Reimplemented from mtsGenericObject.

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

void prmFixtureGainCartesianSet::SetForceBiasNeg

(

const vct3 &

newValue

)

void prmFixtureGainCartesianSet::SetForceBiasPos

(

const vct3 &

newValue

)

void prmFixtureGainCartesianSet::SetForceOrientation

(

const vctMatRot3 &

newValue

)

void prmFixtureGainCartesianSet::SetForcePosition

(

const vct3 &

newValue

)

void prmFixtureGainCartesianSet::SetOrientationDampingNeg

(

const vct3 &

newValue

)

void prmFixtureGainCartesianSet::SetOrientationDampingPos

(

const vct3 &

newValue

)

void prmFixtureGainCartesianSet::SetOrientationStiffnessNeg

(

const vct3 &

newValue

)

void prmFixtureGainCartesianSet::SetOrientationStiffnessPos

(

const vct3 &

newValue

)

void prmFixtureGainCartesianSet::SetPositionDampingNeg

(

const vct3 &

newValue

)

void prmFixtureGainCartesianSet::SetPositionDampingPos

(

const vct3 &

newValue

)

void prmFixtureGainCartesianSet::SetPositionStiffnessNeg

(

const vct3 &

newValue

)

void prmFixtureGainCartesianSet::SetPositionStiffnessPos

(

const vct3 &

newValue

)

void prmFixtureGainCartesianSet::SetTorqueBiasNeg

(

const vct3 &

newValue

)

void prmFixtureGainCartesianSet::SetTorqueBiasPos

(

const vct3 &

newValue

)

void prmFixtureGainCartesianSet::SetTorqueOrientation

(

const vctMatRot3 &

newValue

)

const vct3& prmFixtureGainCartesianSet::TorqueBiasNeg

(

void

)

const

vct3& prmFixtureGainCartesianSet::TorqueBiasNeg

(

void

)

const vct3& prmFixtureGainCartesianSet::TorqueBiasPos

(

void

)

const

vct3& prmFixtureGainCartesianSet::TorqueBiasPos

(

void

)

const vctMatRot3& prmFixtureGainCartesianSet::TorqueOrientation

(

void

)

const

vctMatRot3& prmFixtureGainCartesianSet::TorqueOrientation

(

void

)

void prmFixtureGainCartesianSet::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 prmFixtureGainCartesianSet::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

vct3 prmFixtureGainCartesianSet::mForceBiasNeg

protected

vct3 prmFixtureGainCartesianSet::mForceBiasPos

protected

vctMatRot3 prmFixtureGainCartesianSet::mForceOrientation

protected

vct3 prmFixtureGainCartesianSet::mForcePosition

protected

vct3 prmFixtureGainCartesianSet::mOrientationDampingNeg

protected

vct3 prmFixtureGainCartesianSet::mOrientationDampingPos

protected

vct3 prmFixtureGainCartesianSet::mOrientationStiffnessNeg

protected

vct3 prmFixtureGainCartesianSet::mOrientationStiffnessPos

protected

vct3 prmFixtureGainCartesianSet::mPositionDampingNeg

protected

vct3 prmFixtureGainCartesianSet::mPositionDampingPos

protected

vct3 prmFixtureGainCartesianSet::mPositionStiffnessNeg

protected

vct3 prmFixtureGainCartesianSet::mPositionStiffnessPos

protected

vct3 prmFixtureGainCartesianSet::mTorqueBiasNeg

protected

vct3 prmFixtureGainCartesianSet::mTorqueBiasPos

protected

vctMatRot3 prmFixtureGainCartesianSet::mTorqueOrientation

protected

---

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

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