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

#include <prmInputData.h>

Inheritance diagram for prmInputData:
mtsGenericObject cmnGenericObject

Public Member Functions

 prmInputData (void)
 prmInputData (const prmInputData &other)
prmInputData & operator= (const prmInputData &other)
 ~prmInputData ()
void GetAnalogInputs (vctDoubleVec &placeHolder) const
vctDoubleVec GetAnalogInputs (void) const
void SetAnalogInputs (const vctDoubleVec &newValue)
const vctDoubleVec & AnalogInputs (void) const
vctDoubleVec & AnalogInputs (void)
void GetDigitalInputs (vctBoolVec &placeHolder) const
vctBoolVec GetDigitalInputs (void) const
void SetDigitalInputs (const vctBoolVec &newValue)
const vctBoolVec & DigitalInputs (void) const
vctBoolVec & DigitalInputs (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 prmInputData &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

vctDoubleVec mAnalogInputs
vctBoolVec mDigitalInputs

Constructor & Destructor Documentation

◆ prmInputData() [1/2]

prmInputData::prmInputData ( void )

◆ prmInputData() [2/2]

prmInputData::prmInputData ( const prmInputData & other)

◆ ~prmInputData()

prmInputData::~prmInputData ( )

Member Function Documentation

◆ AnalogInputs() [1/2]

vctDoubleVec & prmInputData::AnalogInputs ( void )

◆ AnalogInputs() [2/2]

const vctDoubleVec & prmInputData::AnalogInputs ( void ) const

◆ Copy()

void prmInputData::Copy ( const prmInputData & source)

◆ DeSerializeRaw()

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

Binary deserialization

Reimplemented from mtsGenericObject.

◆ DigitalInputs() [1/2]

vctBoolVec & prmInputData::DigitalInputs ( void )

◆ DigitalInputs() [2/2]

const vctBoolVec & prmInputData::DigitalInputs ( void ) const

◆ GetAnalogInputs() [1/2]

void prmInputData::GetAnalogInputs ( vctDoubleVec & placeHolder) const

◆ GetAnalogInputs() [2/2]

vctDoubleVec prmInputData::GetAnalogInputs ( void ) const
inline

◆ GetDigitalInputs() [1/2]

void prmInputData::GetDigitalInputs ( vctBoolVec & placeHolder) const

◆ GetDigitalInputs() [2/2]

vctBoolVec prmInputData::GetDigitalInputs ( void ) const
inline

◆ operator=()

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

◆ ScalarNumber()

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

Binary serialization

Reimplemented from mtsGenericObject.

◆ SetAnalogInputs()

void prmInputData::SetAnalogInputs ( const vctDoubleVec & newValue)

◆ SetDigitalInputs()

void prmInputData::SetDigitalInputs ( const vctBoolVec & newValue)

◆ ToStream()

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

◆ mAnalogInputs

vctDoubleVec prmInputData::mAnalogInputs
protected

◆ mDigitalInputs

vctBoolVec prmInputData::mDigitalInputs
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 prmInputData::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