mtsComponentConstructorArg Class Reference

#include <mtsParameterTypes.h>

Inheritance diagram for mtsComponentConstructorArg:

Public Member Functions
	mtsComponentConstructorArg (void)
	mtsComponentConstructorArg (const mtsComponentConstructorArg &other)
mtsComponentConstructorArg &	operator= (const mtsComponentConstructorArg &other)
	~mtsComponentConstructorArg ()
	CMN_DECLARE_SERVICES (CMN_DYNAMIC_CREATION, CMN_LOG_ALLOW_DEFAULT)
	mtsComponentConstructorArg (const std::string &newName)
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 mtsComponentConstructorArg &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=' ')
size_t	ScalarNumber (void) const
bool	ScalarNumberIsFixed (void) const
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
std::string	Name
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

Constructor & Destructor Documentation

mtsComponentConstructorArg() [1/3]

mtsComponentConstructorArg::mtsComponentConstructorArg

(

void

)

mtsComponentConstructorArg() [2/3]

mtsComponentConstructorArg::mtsComponentConstructorArg

(

const mtsComponentConstructorArg &

other

)

~mtsComponentConstructorArg()

mtsComponentConstructorArg::~mtsComponentConstructorArg

(

)

mtsComponentConstructorArg() [3/3]

mtsComponentConstructorArg::mtsComponentConstructorArg

(

const std::string &

newName

)

Member Function Documentation

CMN_DECLARE_SERVICES()

mtsComponentConstructorArg::CMN_DECLARE_SERVICES	(	CMN_DYNAMIC_CREATION	,
		CMN_LOG_ALLOW_DEFAULT	)

Copy()

void mtsComponentConstructorArg::Copy

(

const mtsComponentConstructorArg &

source

)

DeSerializeRaw()

void mtsComponentConstructorArg::DeSerializeRaw ( std::istream & inputStream )

overridevirtual

Binary deserialization

Reimplemented from mtsGenericObject.

operator=()

mtsComponentConstructorArg & mtsComponentConstructorArg::operator=

(

const mtsComponentConstructorArg &

other

)

ScalarNumber()

size_t mtsComponentConstructorArg::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 cmnGenericObject.

ScalarNumberIsFixed()

bool mtsComponentConstructorArg::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 cmnGenericObject.

SerializeRaw()

void mtsComponentConstructorArg::SerializeRaw ( std::ostream & outputStream ) const

overridevirtual

Binary serialization

Reimplemented from mtsGenericObject.

ToStream()

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

Name

std::string mtsComponentConstructorArg::Name

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 mtsComponentConstructorArg::SerializeDescription(const char delimiter=',', const std::string &userDescription="") const

---

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

• tmp/cisst-saw/build/cisst/include/cisstMultiTask/mtsParameterTypes.h