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

#include <prmForwardKinematicsResponse.h>

Inheritance diagram for prmForwardKinematicsResponse:
mtsGenericObject cmnGenericObject

Public Member Functions

 prmForwardKinematicsResponse (void)
 prmForwardKinematicsResponse (const prmForwardKinematicsResponse &other)
prmForwardKinematicsResponse & operator= (const prmForwardKinematicsResponse &other)
 ~prmForwardKinematicsResponse ()
void Getcp (vctFrm4x4 &placeHolder) const
vctFrm4x4 Getcp (void) const
void Setcp (const vctFrm4x4 &newValue)
const vctFrm4x4 & cp (void) const
vctFrm4x4 & cp (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 prmForwardKinematicsResponse &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

vctFrm4x4 mcp
bool mresult
std::string mmessage

Constructor & Destructor Documentation

◆ prmForwardKinematicsResponse() [1/2]

prmForwardKinematicsResponse::prmForwardKinematicsResponse ( void )

◆ prmForwardKinematicsResponse() [2/2]

prmForwardKinematicsResponse::prmForwardKinematicsResponse ( const prmForwardKinematicsResponse & other)

◆ ~prmForwardKinematicsResponse()

prmForwardKinematicsResponse::~prmForwardKinematicsResponse ( )

Member Function Documentation

◆ Copy()

void prmForwardKinematicsResponse::Copy ( const prmForwardKinematicsResponse & source)

◆ cp() [1/2]

vctFrm4x4 & prmForwardKinematicsResponse::cp ( void )

◆ cp() [2/2]

const vctFrm4x4 & prmForwardKinematicsResponse::cp ( void ) const

◆ DeSerializeRaw()

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

Binary deserialization

Reimplemented from mtsGenericObject.

◆ Getcp() [1/2]

void prmForwardKinematicsResponse::Getcp ( vctFrm4x4 & placeHolder) const

◆ Getcp() [2/2]

vctFrm4x4 prmForwardKinematicsResponse::Getcp ( void ) const
inline

◆ Getmessage() [1/2]

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

◆ Getmessage() [2/2]

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

◆ Getresult() [1/2]

void prmForwardKinematicsResponse::Getresult ( bool & placeHolder) const

◆ Getresult() [2/2]

bool prmForwardKinematicsResponse::Getresult ( void ) const
inline

◆ message() [1/2]

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

◆ message() [2/2]

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

◆ operator=()

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

◆ result() [1/2]

bool & prmForwardKinematicsResponse::result ( void )

◆ result() [2/2]

const bool & prmForwardKinematicsResponse::result ( void ) const

◆ ScalarNumber()

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

Binary serialization

Reimplemented from mtsGenericObject.

◆ Setcp()

void prmForwardKinematicsResponse::Setcp ( const vctFrm4x4 & newValue)

◆ Setmessage()

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

◆ Setresult()

void prmForwardKinematicsResponse::Setresult ( const bool & newValue)

◆ ToStream()

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

◆ mcp

vctFrm4x4 prmForwardKinematicsResponse::mcp
protected

◆ mmessage

std::string prmForwardKinematicsResponse::mmessage
protected

◆ mresult

bool prmForwardKinematicsResponse::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 prmForwardKinematicsResponse::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