cisst-saw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Public Attributes | List of all members
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
 
void DeSerializeRaw (std::istream &inputStream)
 
void ToStream (std::ostream &outputStream) const
 
virtual void ToStreamRaw (std::ostream &outputStream, const char delimiter= ' ', bool headerOnly=false, const std::string &headerPrefix="") const
 
virtual bool FromStreamRaw (std::istream &inputStream, const char delimiter= ' ')
 
- Public Member Functions inherited from mtsGenericObject
 mtsGenericObject (void)
 
 mtsGenericObject (double timestamp, bool automaticTimestamp, bool valid)
 
 mtsGenericObject (const mtsGenericObject &other)
 
virtual ~mtsGenericObject (void)
 
bool SetTimestampIfAutomatic (double timestamp)
 
size_t ScalarNumber (void) const
 
bool ScalarNumberIsFixed (void) const
 
double Scalar (const size_t index) const throw (std::out_of_range)
 
std::string ScalarDescription (const size_t index, const std::string &userDescription="") const throw (std::out_of_range)
 
- 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::StreamBufTypeGetLogMultiplexer (void) const
 
virtual double Scalar (const size_t CMN_UNUSED(index)) const throw (std::out_of_range)
 
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

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

Member Function Documentation

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

Binary deserialization

Reimplemented from mtsGenericObject.

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

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

Reimplemented from mtsGenericObject.

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

Binary serialization

Reimplemented from mtsGenericObject.

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

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.

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

Raw text output to stream

Reimplemented from mtsGenericObject.

Member Data Documentation

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

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