mtsTaskPeriodicConstructorArg Class Reference

#include <mtsParameterTypes.h>

Inheritance diagram for mtsTaskPeriodicConstructorArg:

Public Member Functions
	mtsTaskPeriodicConstructorArg (void)
	mtsTaskPeriodicConstructorArg (const mtsTaskPeriodicConstructorArg &other)
mtsTaskPeriodicConstructorArg &	operator= (const mtsTaskPeriodicConstructorArg &other)
	~mtsTaskPeriodicConstructorArg ()
	CMN_DECLARE_SERVICES (CMN_DYNAMIC_CREATION, CMN_LOG_ALLOW_DEFAULT)
	mtsTaskPeriodicConstructorArg (const std::string &newName, const double &newPeriod, const bool &newIsHardRealTime, const unsigned int &newStateTableSize)
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 mtsTaskPeriodicConstructorArg &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
std::string	Name
double	Period
bool	IsHardRealTime
unsigned int	StateTableSize
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

mtsTaskPeriodicConstructorArg() [1/3]

mtsTaskPeriodicConstructorArg::mtsTaskPeriodicConstructorArg

(

void

)

mtsTaskPeriodicConstructorArg() [2/3]

mtsTaskPeriodicConstructorArg::mtsTaskPeriodicConstructorArg

(

const mtsTaskPeriodicConstructorArg &

other

)

~mtsTaskPeriodicConstructorArg()

mtsTaskPeriodicConstructorArg::~mtsTaskPeriodicConstructorArg

(

)

mtsTaskPeriodicConstructorArg() [3/3]

mtsTaskPeriodicConstructorArg::mtsTaskPeriodicConstructorArg	(	const std::string &	newName,
		const double &	newPeriod,
		const bool &	newIsHardRealTime,
		const unsigned int &	newStateTableSize )

Member Function Documentation

CMN_DECLARE_SERVICES()

mtsTaskPeriodicConstructorArg::CMN_DECLARE_SERVICES	(	CMN_DYNAMIC_CREATION	,
		CMN_LOG_ALLOW_DEFAULT	)

Copy()

void mtsTaskPeriodicConstructorArg::Copy

(

const mtsTaskPeriodicConstructorArg &

source

)

DeSerializeRaw()

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

overridevirtual

Binary deserialization

Reimplemented from mtsGenericObject.

operator=()

mtsTaskPeriodicConstructorArg & mtsTaskPeriodicConstructorArg::operator=

(

const mtsTaskPeriodicConstructorArg &

other

)

ScalarNumber()

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

overridevirtual

Binary serialization

Reimplemented from mtsGenericObject.

ToStream()

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

IsHardRealTime

bool mtsTaskPeriodicConstructorArg::IsHardRealTime

Name

std::string mtsTaskPeriodicConstructorArg::Name

Period

double mtsTaskPeriodicConstructorArg::Period

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

StateTableSize

unsigned int mtsTaskPeriodicConstructorArg::StateTableSize

---

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

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