prmInverseKinematicsRequest Class Reference

#include <prmInverseKinematicsRequest.h>

Inheritance diagram for prmInverseKinematicsRequest:

Public Member Functions
	prmInverseKinematicsRequest (void)
	prmInverseKinematicsRequest (const prmInverseKinematicsRequest &other)
prmInverseKinematicsRequest &	operator= (const prmInverseKinematicsRequest &other)
	~prmInverseKinematicsRequest ()
void	Getjp (vctDynamicVector< double > &placeHolder) const
vctDynamicVector< double >	Getjp (void) const
void	Setjp (const vctDynamicVector< double > &newValue)
const vctDynamicVector< double > &	jp (void) const
vctDynamicVector< double > &	jp (void)
void	Getcp (vctFrm4x4 &placeHolder) const
vctFrm4x4	Getcp (void) const
void	Setcp (const vctFrm4x4 &newValue)
const vctFrm4x4 &	cp (void) const
vctFrm4x4 &	cp (void)
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 prmInverseKinematicsRequest &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
vctDynamicVector< double >	mjp
vctFrm4x4	mcp

Constructor & Destructor Documentation

prmInverseKinematicsRequest() [1/2]

prmInverseKinematicsRequest::prmInverseKinematicsRequest

(

void

)

prmInverseKinematicsRequest() [2/2]

prmInverseKinematicsRequest::prmInverseKinematicsRequest

(

const prmInverseKinematicsRequest &

other

)

~prmInverseKinematicsRequest()

prmInverseKinematicsRequest::~prmInverseKinematicsRequest

(

)

Member Function Documentation

Copy()

void prmInverseKinematicsRequest::Copy

(

const prmInverseKinematicsRequest &

source

)

cp() [1/2]

vctFrm4x4 & prmInverseKinematicsRequest::cp

(

void

)

cp() [2/2]

const vctFrm4x4 & prmInverseKinematicsRequest::cp

(

void

)

const

DeSerializeRaw()

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

overridevirtual

Binary deserialization

Reimplemented from mtsGenericObject.

Getcp() [1/2]

void prmInverseKinematicsRequest::Getcp

(

vctFrm4x4 &

placeHolder

)

const

Getcp() [2/2]

vctFrm4x4 prmInverseKinematicsRequest::Getcp ( void ) const

inline

Getjp() [1/2]

void prmInverseKinematicsRequest::Getjp

(

vctDynamicVector< double > &

placeHolder

)

const

Getjp() [2/2]

vctDynamicVector< double > prmInverseKinematicsRequest::Getjp ( void ) const

inline

jp() [1/2]

vctDynamicVector< double > & prmInverseKinematicsRequest::jp

(

void

)

jp() [2/2]

const vctDynamicVector< double > & prmInverseKinematicsRequest::jp

(

void

)

const

operator=()

prmInverseKinematicsRequest & prmInverseKinematicsRequest::operator=

(

const prmInverseKinematicsRequest &

other

)

ScalarNumber()

size_t prmInverseKinematicsRequest::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 prmInverseKinematicsRequest::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 prmInverseKinematicsRequest::SerializeRaw ( std::ostream & outputStream ) const

overridevirtual

Binary serialization

Reimplemented from mtsGenericObject.

Setcp()

void prmInverseKinematicsRequest::Setcp

(

const vctFrm4x4 &

newValue

)

Setjp()

void prmInverseKinematicsRequest::Setjp

(

const vctDynamicVector< double > &

newValue

)

ToStream()

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

overridevirtual

Raw text output to stream

Reimplemented from mtsGenericObject.

Member Data Documentation

HumanReadable

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

mcp

vctFrm4x4 prmInverseKinematicsRequest::mcp

protected

mjp

vctDynamicVector<double> prmInverseKinematicsRequest::mjp

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 prmInverseKinematicsRequest::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/prmInverseKinematicsRequest.h