#include <mtsTaskPeriodic.h>

Inheritance diagram for mtsTaskPeriodicConstructorArg:

Public Types
enum	{ STATE_TABLE_DEFAULT_SIZE = 256 }

Public Member Functions
	mtsTaskPeriodicConstructorArg ()

	mtsTaskPeriodicConstructorArg (const std::string &name, double period, bool isHardRealTime=false, unsigned int sizeStateTable=STATE_TABLE_DEFAULT_SIZE)

	mtsTaskPeriodicConstructorArg (const mtsTaskPeriodicConstructorArg &other)

	~mtsTaskPeriodicConstructorArg ()

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::StreamBufType *	GetLogMultiplexer (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

double	Period

bool	IsHardRealTime

unsigned int	StateTableSize

Member Enumeration Documentation

anonymous enum

Enumerator
STATE_TABLE_DEFAULT_SIZE

Constructor & Destructor Documentation

mtsTaskPeriodicConstructorArg::mtsTaskPeriodicConstructorArg ( )

inline

mtsTaskPeriodicConstructorArg::mtsTaskPeriodicConstructorArg	(	const std::string &	name,
		double	period,
		bool	isHardRealTime = `false`,
		unsigned int	sizeStateTable = `STATE_TABLE_DEFAULT_SIZE`
	)

inline

mtsTaskPeriodicConstructorArg::mtsTaskPeriodicConstructorArg ( const mtsTaskPeriodicConstructorArg & other )

inline

mtsTaskPeriodicConstructorArg::~mtsTaskPeriodicConstructorArg ( )

inline

Member Function Documentation

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

virtual

Binary deserialization

Reimplemented from mtsGenericObject.

virtual bool mtsTaskPeriodicConstructorArg::FromStreamRaw	(	std::istream &	inputStream,
		const char	delimiter = `' '`
	)

virtual

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

Reimplemented from mtsGenericObject.

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

virtual

Binary serialization

Reimplemented from mtsGenericObject.

void mtsTaskPeriodicConstructorArg::ToStream ( std::ostream & outputStream ) const

virtual

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.

virtual void mtsTaskPeriodicConstructorArg::ToStreamRaw	(	std::ostream &	outputStream,
		const char	delimiter = `' '`,
		bool	headerOnly = `false`,
		const std::string &	headerPrefix = `""`
	)		const

virtual

Raw text output to stream

Reimplemented from mtsGenericObject.

Member Data Documentation

bool mtsTaskPeriodicConstructorArg::IsHardRealTime

std::string mtsTaskPeriodicConstructorArg::Name

double mtsTaskPeriodicConstructorArg::Period

unsigned int mtsTaskPeriodicConstructorArg::StateTableSize

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

/home/adeguet1/catkin_ws/src/cisst-saw/cisst/cisstMultiTask/mtsTaskPeriodic.h

Public Types

Public Member Functions

Public Attributes

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation