#include <mtsParameterTypes.h>

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

Public Member Functions
	mtsComponentStatusControl (void)
	mtsComponentStatusControl (const mtsComponentStatusControl &other)
mtsComponentStatusControl &	operator= (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)
bool	ScalarNumberIsFixed (void) const
size_t	ScalarNumber (void) const

Static Public Member Functions
static const std::vector< std::string > &	ComponentStatusCommandVectorString (void)

Public Attributes
std::string	ProcessName
std::string	ComponentName
double	DelayInSecond
ComponentStatusCommand	Command
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

Static Public Attributes
static std::string static ComponentStatusCommandToString(const ComponentStatusCommand &value) CISST_THROW(std ComponentStatusCommand static ComponentStatusCommandFromString(const std::string &value) CISST_THROW(std const std::vector< int > &	ComponentStatusCommandVectorInt (void)

Member Enumeration Documentation

◆ ComponentStatusCommand

enum mtsComponentStatusControl::ComponentStatusCommand

Enumerator
COMPONENT_START
COMPONENT_STOP
COMPONENT_RESUME

Constructor & Destructor Documentation

◆ mtsComponentStatusControl() [1/3]

mtsComponentStatusControl::mtsComponentStatusControl ( void )

◆ mtsComponentStatusControl() [2/3]

mtsComponentStatusControl::mtsComponentStatusControl ( const mtsComponentStatusControl & other )

◆ ~mtsComponentStatusControl()

mtsComponentStatusControl::~mtsComponentStatusControl ( )

◆ mtsComponentStatusControl() [3/3]

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

Member Function Documentation

◆ ComponentStatusCommandVectorString()

const std::vector< std::string > & mtsComponentStatusControl::ComponentStatusCommandVectorString ( void )

static

◆ Copy()

void mtsComponentStatusControl::Copy ( const mtsComponentStatusControl & source )

◆ DeSerializeRaw()

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

◆ operator=()

mtsComponentStatusControl & mtsComponentStatusControl::operator= ( const mtsComponentStatusControl & other )

◆ ScalarNumber()

size_t mtsComponentStatusControl::ScalarNumber ( void ) const

◆ ScalarNumberIsFixed()

bool mtsComponentStatusControl::ScalarNumberIsFixed ( void ) const

◆ SerializeRaw()

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

◆ ToStream()

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

◆ ToStreamRaw()

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

Member Data Documentation

◆ Command

ComponentStatusCommand mtsComponentStatusControl::Command

◆ ComponentName

std::string mtsComponentStatusControl::ComponentName

◆ ComponentStatusCommandVectorInt

std::string static ComponentStatusCommandToString(const ComponentStatusCommand &value) CISST_THROW(std ComponentStatusCommand static ComponentStatusCommandFromString(const std::string &value) CISST_THROW(std const std::vector< int > & mtsComponentStatusControl::ComponentStatusCommandVectorInt(void)

static

◆ DelayInSecond

double mtsComponentStatusControl::DelayInSecond

◆ HumanReadable

void DeSerializeText(std::istream &inputStream, const char delimiter=',') CISST_THROW(std std::string mtsComponentStatusControl::HumanReadable(void) const

◆ ProcessName

std::string mtsComponentStatusControl::ProcessName

◆ 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 mtsComponentStatusControl::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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes