cisst-saw
Loading...
Searching...
No Matches
mtsComponentConstructorNameAndArg< T > Class Template Reference

#include <mtsComponent.h>

Inheritance diagram for mtsComponentConstructorNameAndArg< T >:
mtsGenericObject cmnGenericObject

Public Member Functions

 mtsComponentConstructorNameAndArg ()
 mtsComponentConstructorNameAndArg (const std::string &name, const T &arg)
 ~mtsComponentConstructorNameAndArg ()
void SerializeRaw (std::ostream &outputStream) const override
void DeSerializeRaw (std::istream &inputStream) override
void ToStream (std::ostream &outputStream) const override
virtual void ToStreamRaw (std::ostream &outputStream, const char delimiter=' ', bool headerOnly=false, const std::string &headerPrefix="") const override
virtual bool FromStreamRaw (std::istream &inputStream, const char delimiter=' ') override
Public Member Functions inherited from mtsGenericObject
 mtsGenericObject (void)
 mtsGenericObject (double timestamp, bool automaticTimestamp, bool valid)
 mtsGenericObject (const mtsGenericObject &other)
virtual ~mtsGenericObject (void)
mtsGenericObjectoperator= (const mtsGenericObject &other)
bool SetTimestampIfAutomatic (double timestamp)
size_t ScalarNumber (void) const
bool ScalarNumberIsFixed (void) const
Public Member Functions inherited from cmnGenericObject
virtual ~cmnGenericObject (void)
virtual const cmnClassServicesBaseServices (void) const =0
bool ReconstructFrom (const cmnGenericObject &other)
std::string ToString (void) const
virtual cmnLogger::StreamBufTypeGetLogMultiplexer (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

std::string Name
Arg

Detailed Description

template<class T>
class mtsComponentConstructorNameAndArg< T >

mtsComponentConstructorNameAndArg<T> can be used to provide a name and additional argument (of type T) to a component constructor that takes a single argument. Type T must be streamable, and must be supported by cmnSerializeRaw and cmnDeSerializeRaw.

Constructor & Destructor Documentation

◆ mtsComponentConstructorNameAndArg() [1/2]

template<class T>
mtsComponentConstructorNameAndArg< T >::mtsComponentConstructorNameAndArg ( )
inline

◆ mtsComponentConstructorNameAndArg() [2/2]

template<class T>
mtsComponentConstructorNameAndArg< T >::mtsComponentConstructorNameAndArg ( const std::string & name,
const T & arg )
inline

◆ ~mtsComponentConstructorNameAndArg()

Member Function Documentation

◆ DeSerializeRaw()

template<class T>
void mtsComponentConstructorNameAndArg< T >::DeSerializeRaw ( std::istream & inputStream)
inlineoverridevirtual

Binary deserialization

Reimplemented from mtsGenericObject.

◆ FromStreamRaw()

template<class T>
virtual bool mtsComponentConstructorNameAndArg< T >::FromStreamRaw ( std::istream & inputStream,
const char delimiter = ' ' )
inlineoverridevirtual

Read from an unformatted text input (e.g., one created by ToStreamRaw). Returns true if successful.

Reimplemented from mtsGenericObject.

◆ SerializeRaw()

template<class T>
void mtsComponentConstructorNameAndArg< T >::SerializeRaw ( std::ostream & outputStream) const
inlineoverridevirtual

Binary serialization

Reimplemented from mtsGenericObject.

◆ ToStream()

template<class T>
void mtsComponentConstructorNameAndArg< T >::ToStream ( std::ostream & outputStream) const
inlineoverridevirtual

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()

template<class T>
virtual void mtsComponentConstructorNameAndArg< T >::ToStreamRaw ( std::ostream & outputStream,
const char delimiter = ' ',
bool headerOnly = false,
const std::string & headerPrefix = "" ) const
inlineoverridevirtual

Raw text output to stream

Reimplemented from mtsGenericObject.

Member Data Documentation

◆ Arg

template<class T>
T mtsComponentConstructorNameAndArg< T >::Arg

◆ Name

template<class T>
std::string mtsComponentConstructorNameAndArg< T >::Name

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