mtsInterfaceRequiredDescription Class Reference

#include <mtsInterfaceCommon.h>

Public Member Functions
	mtsInterfaceRequiredDescription (void)
	mtsInterfaceRequiredDescription (const mtsInterfaceRequiredDescription &other)
	~mtsInterfaceRequiredDescription ()
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 mtsInterfaceRequiredDescription &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)

Public Attributes
std::string	InterfaceName
mtsCommandPointerNames	FunctionVoidNames
mtsCommandPointerNames	FunctionWriteNames
mtsCommandPointerNames	FunctionReadNames
mtsCommandPointerNames	FunctionQualifiedReadNames
mtsCommandPointerNames	FunctionVoidReturnNames
mtsCommandPointerNames	FunctionWriteReturnNames
mtsEventHandlersVoidDescription	EventHandlersVoid
mtsEventHandlersWriteDescription	EventHandlersWrite
bool	IsRequired

Constructor & Destructor Documentation

mtsInterfaceRequiredDescription::mtsInterfaceRequiredDescription

(

void

)

mtsInterfaceRequiredDescription::mtsInterfaceRequiredDescription

(

const mtsInterfaceRequiredDescription &

other

)

mtsInterfaceRequiredDescription::~mtsInterfaceRequiredDescription

(

)

Member Function Documentation

void mtsInterfaceRequiredDescription::Copy

(

const mtsInterfaceRequiredDescription &

source

)

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

void mtsInterfaceRequiredDescription::DeSerializeRaw

(

std::istream &

inputStream

)

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

std::string mtsInterfaceRequiredDescription::HumanReadable

(

void

)

const

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

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

size_t mtsInterfaceRequiredDescription::ScalarNumber

(

void

)

const

bool mtsInterfaceRequiredDescription::ScalarNumberIsFixed

(

void

)

const

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

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

void mtsInterfaceRequiredDescription::SerializeRaw

(

std::ostream &

outputStream

)

const

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

void mtsInterfaceRequiredDescription::ToStream

(

std::ostream &

outputStream

)

const

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

Member Data Documentation

mtsEventHandlersVoidDescription mtsInterfaceRequiredDescription::EventHandlersVoid

mtsEventHandlersWriteDescription mtsInterfaceRequiredDescription::EventHandlersWrite

mtsCommandPointerNames mtsInterfaceRequiredDescription::FunctionQualifiedReadNames

mtsCommandPointerNames mtsInterfaceRequiredDescription::FunctionReadNames

mtsCommandPointerNames mtsInterfaceRequiredDescription::FunctionVoidNames

mtsCommandPointerNames mtsInterfaceRequiredDescription::FunctionVoidReturnNames

mtsCommandPointerNames mtsInterfaceRequiredDescription::FunctionWriteNames

mtsCommandPointerNames mtsInterfaceRequiredDescription::FunctionWriteReturnNames

std::string mtsInterfaceRequiredDescription::InterfaceName

bool mtsInterfaceRequiredDescription::IsRequired

---

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

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