mtsCommandWriteReturnDescription Class Reference

#include <mtsInterfaceCommon.h>

Public Member Functions
	mtsCommandWriteReturnDescription (void)
	mtsCommandWriteReturnDescription (const mtsCommandWriteReturnDescription &other)
mtsCommandWriteReturnDescription &	operator= (const mtsCommandWriteReturnDescription &other)
	~mtsCommandWriteReturnDescription ()
	mtsCommandWriteReturnDescription (const std::string &newName, const std::string &newArgumentPrototypeSerialized, const std::string &newResultPrototypeSerialized)
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 mtsCommandWriteReturnDescription &source)
bool	ScalarNumberIsFixed (void) const
size_t	ScalarNumber (void) const

Public Attributes
std::string	Name
std::string	ArgumentPrototypeSerialized
std::string	ResultPrototypeSerialized
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

Constructor & Destructor Documentation

mtsCommandWriteReturnDescription() [1/3]

mtsCommandWriteReturnDescription::mtsCommandWriteReturnDescription

(

void

)

mtsCommandWriteReturnDescription() [2/3]

mtsCommandWriteReturnDescription::mtsCommandWriteReturnDescription

(

const mtsCommandWriteReturnDescription &

other

)

~mtsCommandWriteReturnDescription()

mtsCommandWriteReturnDescription::~mtsCommandWriteReturnDescription

(

)

mtsCommandWriteReturnDescription() [3/3]

mtsCommandWriteReturnDescription::mtsCommandWriteReturnDescription	(	const std::string &	newName,
		const std::string &	newArgumentPrototypeSerialized,
		const std::string &	newResultPrototypeSerialized )

Member Function Documentation

Copy()

void mtsCommandWriteReturnDescription::Copy

(

const mtsCommandWriteReturnDescription &

source

)

DeSerializeRaw()

void mtsCommandWriteReturnDescription::DeSerializeRaw

(

std::istream &

inputStream

)

operator=()

mtsCommandWriteReturnDescription & mtsCommandWriteReturnDescription::operator=

(

const mtsCommandWriteReturnDescription &

other

)

ScalarNumber()

size_t mtsCommandWriteReturnDescription::ScalarNumber

(

void

)

const

ScalarNumberIsFixed()

bool mtsCommandWriteReturnDescription::ScalarNumberIsFixed

(

void

)

const

SerializeRaw()

void mtsCommandWriteReturnDescription::SerializeRaw

(

std::ostream &

outputStream

)

const

ToStream()

void mtsCommandWriteReturnDescription::ToStream

(

std::ostream &

outputStream

)

const

ToStreamRaw()

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

Member Data Documentation

ArgumentPrototypeSerialized

std::string mtsCommandWriteReturnDescription::ArgumentPrototypeSerialized

HumanReadable

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

Name

std::string mtsCommandWriteReturnDescription::Name

ResultPrototypeSerialized

std::string mtsCommandWriteReturnDescription::ResultPrototypeSerialized

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 mtsCommandWriteReturnDescription::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/mtsInterfaceCommon.h