mtsInterfaceProvidedDescription Class Reference

#include <mtsInterfaceCommon.h>

Public Member Functions
	mtsInterfaceProvidedDescription (void)
	mtsInterfaceProvidedDescription (const mtsInterfaceProvidedDescription &other)
	~mtsInterfaceProvidedDescription ()
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 mtsInterfaceProvidedDescription &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
mtsCommandsVoidDescription	CommandsVoid
mtsCommandsWriteDescription	CommandsWrite
mtsCommandsReadDescription	CommandsRead
mtsCommandsQualifiedReadDescription	CommandsQualifiedRead
mtsCommandsVoidReturnDescription	CommandsVoidReturn
mtsCommandsWriteReturnDescription	CommandsWriteReturn
mtsEventsVoidDescription	EventsVoid
mtsEventsWriteDescription	EventsWrite

Constructor & Destructor Documentation

mtsInterfaceProvidedDescription::mtsInterfaceProvidedDescription

(

void

)

mtsInterfaceProvidedDescription::mtsInterfaceProvidedDescription

(

const mtsInterfaceProvidedDescription &

other

)

mtsInterfaceProvidedDescription::~mtsInterfaceProvidedDescription

(

)

Member Function Documentation

void mtsInterfaceProvidedDescription::Copy

(

const mtsInterfaceProvidedDescription &

source

)

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

void mtsInterfaceProvidedDescription::DeSerializeRaw

(

std::istream &

inputStream

)

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

std::string mtsInterfaceProvidedDescription::HumanReadable

(

void

)

const

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

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

size_t mtsInterfaceProvidedDescription::ScalarNumber

(

void

)

const

bool mtsInterfaceProvidedDescription::ScalarNumberIsFixed

(

void

)

const

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

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

void mtsInterfaceProvidedDescription::SerializeRaw

(

std::ostream &

outputStream

)

const

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

void mtsInterfaceProvidedDescription::ToStream

(

std::ostream &

outputStream

)

const

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

Member Data Documentation

mtsCommandsQualifiedReadDescription mtsInterfaceProvidedDescription::CommandsQualifiedRead

mtsCommandsReadDescription mtsInterfaceProvidedDescription::CommandsRead

mtsCommandsVoidDescription mtsInterfaceProvidedDescription::CommandsVoid

mtsCommandsVoidReturnDescription mtsInterfaceProvidedDescription::CommandsVoidReturn

mtsCommandsWriteDescription mtsInterfaceProvidedDescription::CommandsWrite

mtsCommandsWriteReturnDescription mtsInterfaceProvidedDescription::CommandsWriteReturn

mtsEventsVoidDescription mtsInterfaceProvidedDescription::EventsVoid

mtsEventsWriteDescription mtsInterfaceProvidedDescription::EventsWrite

std::string mtsInterfaceProvidedDescription::InterfaceName

---

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

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