mtsComponentStatusControl Class Reference

#include <mtsParameterTypes.h>

Public Types
enum	ComponentStatusCommand { COMPONENT_START = 0, COMPONENT_STOP, COMPONENT_RESUME }

Public Member Functions
	mtsComponentStatusControl (void)
	mtsComponentStatusControl (const mtsComponentStatusControl &other)
	~mtsComponentStatusControl ()
	mtsComponentStatusControl (const std::string &newProcessName, const std::string &newComponentName, const double &newDelayInSecond, const ComponentStatusCommand &newCommand)
void	SerializeRaw (std::ostream &outputStream) const
void	DeSerializeRaw (std::istream &inputStream)
void	ToStream (std::ostream &outputStream) const
void	ToStreamRaw (std::ostream &outputStream, const char delimiter= ' ', bool headerOnly=false, const std::string &headerPrefix="") const
void	Copy (const mtsComponentStatusControl &source)
void	SerializeBinary (std::ostream &outputStream) const throw (std::runtime_error)
void	DeSerializeBinary (std::istream &inputStream, const cmnDataFormat &localFormat, const cmnDataFormat &remoteFormat) throw (std::runtime_error)
void	SerializeText (std::ostream &outputStream, const char delimiter= ',') const throw (std::runtime_error)
std::string	SerializeDescription (const char delimiter= ',', const std::string &userDescription="") const
void	DeSerializeText (std::istream &inputStream, const char delimiter= ',') throw (std::runtime_error)
std::string	HumanReadable (void) const
bool	ScalarNumberIsFixed (void) const
size_t	ScalarNumber (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)

Static Public Member Functions
static std::string	ComponentStatusCommandToString (const ComponentStatusCommand &value) throw (std::runtime_error)
static ComponentStatusCommand	ComponentStatusCommandFromString (const std::string &value) throw (std::runtime_error)

Public Attributes
std::string	ProcessName
std::string	ComponentName
double	DelayInSecond
ComponentStatusCommand	Command

Member Enumeration Documentation

enum mtsComponentStatusControl::ComponentStatusCommand

Enumerator
COMPONENT_START
COMPONENT_STOP
COMPONENT_RESUME

Constructor & Destructor Documentation

mtsComponentStatusControl::mtsComponentStatusControl

(

void

)

mtsComponentStatusControl::mtsComponentStatusControl

(

const mtsComponentStatusControl &

other

)

mtsComponentStatusControl::~mtsComponentStatusControl

(

)

mtsComponentStatusControl::mtsComponentStatusControl	(	const std::string &	newProcessName,
		const std::string &	newComponentName,
		const double &	newDelayInSecond,
		const ComponentStatusCommand &	newCommand
	)

Member Function Documentation

static ComponentStatusCommand mtsComponentStatusControl::ComponentStatusCommandFromString ( const std::string &  value ) throw ( std::runtime_error )

static

static std::string mtsComponentStatusControl::ComponentStatusCommandToString ( const ComponentStatusCommand &  value ) throw ( std::runtime_error )

static

void mtsComponentStatusControl::Copy

(

const mtsComponentStatusControl &

source

)

void mtsComponentStatusControl::DeSerializeBinary	(	std::istream &	inputStream,
		const cmnDataFormat &	localFormat,
		const cmnDataFormat &	remoteFormat
	)
throw	(	std::runtime_error
	)

void mtsComponentStatusControl::DeSerializeRaw

(

std::istream &

inputStream

)

void mtsComponentStatusControl::DeSerializeText	(	std::istream &	inputStream,
		const char	delimiter = ','
	)
throw	(	std::runtime_error
	)

std::string mtsComponentStatusControl::HumanReadable

(

void

)

const

double mtsComponentStatusControl::Scalar	(	const size_t	index	)	const
throw	(	std::out_of_range
	)

std::string mtsComponentStatusControl::ScalarDescription	(	const size_t	index,
		const std::string &	userDescription = ""
	)		const
throw	(	std::out_of_range
	)

size_t mtsComponentStatusControl::ScalarNumber

(

void

)

const

bool mtsComponentStatusControl::ScalarNumberIsFixed

(

void

)

const

void mtsComponentStatusControl::SerializeBinary	(	std::ostream &	outputStream	)	const
throw	(	std::runtime_error
	)

std::string mtsComponentStatusControl::SerializeDescription	(	const char	delimiter = ',',
		const std::string &	userDescription = ""
	)		const

void mtsComponentStatusControl::SerializeRaw

(

std::ostream &

outputStream

)

const

void mtsComponentStatusControl::SerializeText	(	std::ostream &	outputStream,
		const char	delimiter = ','
	)		const
throw	(	std::runtime_error
	)

void mtsComponentStatusControl::ToStream

(

std::ostream &

outputStream

)

const

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

Member Data Documentation

ComponentStatusCommand mtsComponentStatusControl::Command

std::string mtsComponentStatusControl::ComponentName

double mtsComponentStatusControl::DelayInSecond

std::string mtsComponentStatusControl::ProcessName

---

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

• /home/adeguet1/catkin_ws/build_release/cisst/include/cisstMultiTask/mtsParameterTypes.h