cisst-saw
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Attributes | List of all members
prmInverseKinematicsResponse Class Reference

#include <prmInverseKinematicsResponse.h>

Inheritance diagram for prmInverseKinematicsResponse:
mtsGenericObject cmnGenericObject

Public Member Functions

 prmInverseKinematicsResponse (void)
 prmInverseKinematicsResponse (const prmInverseKinematicsResponse &other)
prmInverseKinematicsResponse & operator= (const prmInverseKinematicsResponse &other)
 ~prmInverseKinematicsResponse ()
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 Getresult (bool &placeHolder) const
bool Getresult (void) const
void Setresult (const bool &newValue)
const bool & result (void) const
bool & result (void)
void Getmessage (std::string &placeHolder) const
std::string Getmessage (void) const
void Setmessage (const std::string &newValue)
const std::string & message (void) const
std::string & message (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 prmInverseKinematicsResponse &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
bool mresult
std::string mmessage

Constructor & Destructor Documentation

◆ prmInverseKinematicsResponse() [1/2]

prmInverseKinematicsResponse::prmInverseKinematicsResponse ( void )

◆ prmInverseKinematicsResponse() [2/2]

prmInverseKinematicsResponse::prmInverseKinematicsResponse ( const prmInverseKinematicsResponse & other)

◆ ~prmInverseKinematicsResponse()

prmInverseKinematicsResponse::~prmInverseKinematicsResponse ( )

Member Function Documentation

◆ Copy()

void prmInverseKinematicsResponse::Copy ( const prmInverseKinematicsResponse & source)

◆ DeSerializeRaw()

void prmInverseKinematicsResponse::DeSerializeRaw ( std::istream & inputStream)
overridevirtual

Binary deserialization

Reimplemented from mtsGenericObject.

◆ Getjp() [1/2]

void prmInverseKinematicsResponse::Getjp ( vctDynamicVector< double > & placeHolder) const

◆ Getjp() [2/2]

vctDynamicVector< double > prmInverseKinematicsResponse::Getjp ( void ) const
inline

◆ Getmessage() [1/2]

void prmInverseKinematicsResponse::Getmessage ( std::string & placeHolder) const

◆ Getmessage() [2/2]

std::string prmInverseKinematicsResponse::Getmessage ( void ) const
inline

◆ Getresult() [1/2]

void prmInverseKinematicsResponse::Getresult ( bool & placeHolder) const

◆ Getresult() [2/2]

bool prmInverseKinematicsResponse::Getresult ( void ) const
inline

◆ jp() [1/2]

vctDynamicVector< double > & prmInverseKinematicsResponse::jp ( void )

◆ jp() [2/2]

const vctDynamicVector< double > & prmInverseKinematicsResponse::jp ( void ) const

◆ message() [1/2]

std::string & prmInverseKinematicsResponse::message ( void )

◆ message() [2/2]

const std::string & prmInverseKinematicsResponse::message ( void ) const

◆ operator=()

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

◆ result() [1/2]

bool & prmInverseKinematicsResponse::result ( void )

◆ result() [2/2]

const bool & prmInverseKinematicsResponse::result ( void ) const

◆ ScalarNumber()

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

Binary serialization

Reimplemented from mtsGenericObject.

◆ Setjp()

void prmInverseKinematicsResponse::Setjp ( const vctDynamicVector< double > & newValue)

◆ Setmessage()

void prmInverseKinematicsResponse::Setmessage ( const std::string & newValue)

◆ Setresult()

void prmInverseKinematicsResponse::Setresult ( const bool & newValue)

◆ ToStream()

void prmInverseKinematicsResponse::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 prmInverseKinematicsResponse::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 prmInverseKinematicsResponse::HumanReadable(void) const

◆ mjp

vctDynamicVector<double> prmInverseKinematicsResponse::mjp
protected

◆ mmessage

std::string prmInverseKinematicsResponse::mmessage
protected

◆ mresult

bool prmInverseKinematicsResponse::mresult
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 prmInverseKinematicsResponse::SerializeDescription(const char delimiter=',', const std::string &userDescription="") const
The documentation for this class was generated from the following file:
Generated by doxygen 1.18.0