cmnData< mtsInterfaceRequiredDescription > Class Reference

#include <mtsInterfaceCommon.h>

Public Types
enum	{ IS_SPECIALIZED = 1 }
typedef mtsInterfaceRequiredDescription	DataType
enum

Public Member Functions
void CISST_EXPORT	Copy (mtsGenericObject &data, const mtsGenericObject &source)
void CISST_EXPORT	SerializeBinary (const mtsGenericObject &data, std::ostream &outputStream) CISST_THROW(std void CISST_EXPORT cmnData< mtsGenericObject >::DeSerializeBinary(mtsGenericObject &data, std::istream &inputStream, const cmnDataFormat &localFormat, const cmnDataFormat &remoteFormat) CISST_THROW(std void CISST_EXPORT cmnData< mtsGenericObject >::SerializeText(const mtsGenericObject &data, std::ostream &outputStream, const char delimiter) CISST_THROW(std std::string CISST_EXPORT cmnData< mtsGenericObject >::SerializeDescription(const mtsGenericObject &data, const char delimiter, const std::string &userDescription)
bool CISST_EXPORT	ScalarNumberIsFixed (const mtsGenericObject &data)
size_t CISST_EXPORT	ScalarNumber (const mtsGenericObject &data)

Static Public Member Functions
static void	Copy (DataType &data, const DataType &source)
static std::string	SerializeDescription (const DataType &data, const char delimiter, const std::string &userDescription)
static void	SerializeBinary (const DataType &data, std::ostream &outputStream) CISST_THROW(std
static void	DeSerializeBinary (DataType &data, std::istream &inputStream, const cmnDataFormat &localFormat, const cmnDataFormat &remoteFormat) CISST_THROW(std
static void	SerializeText (const DataType &data, std::ostream &outputStream, const char delimiter=',') CISST_THROW(std
static void	DeSerializeText (DataType &data, std::istream &inputStream, const char delimiter=',') CISST_THROW(std
static std::string	HumanReadable (const DataType &data)
static bool	ScalarNumberIsFixed (const DataType &data)
static size_t	ScalarNumber (const DataType &data)
static std::string	ScalarDescription (const DataType &data, const size_t index, const std::string &userDescription="") CISST_THROW(std
static double	Scalar (const DataType &data, const size_t index) CISST_THROW(std

Static Public Attributes

static void static SerializeText(const DataType &data, std::ostream &outputStream, const char delimiter=',') CISST_THROW(std void static DeSerializeText(DataType &data, std::istream &inputStream, const char delimiter=',') CISST_THROW(std void static SerializeBinary(const DataType &data, std::ostream &outputStream) CISST_THROW(std void static DeSerializeBinary(DataType &data, std::istream &inputStream, const cmnDataFormat &localFormat, const cmnDataFormat &remoteFormat) CISST_THROW(std size_t

SerializeBinaryByteSize (const DataType &data)

Member Typedef Documentation

DataType

typedef mtsInterfaceRequiredDescription cmnData< mtsInterfaceRequiredDescription >::DataType

Member Enumeration Documentation

anonymous enum

anonymous enum

anonymous enum

anonymous enum

Enumerator
IS_SPECIALIZED

Member Function Documentation

Copy() [1/2]

void cmnData< mtsInterfaceRequiredDescription >::Copy ( DataType & data, const DataType & source )

inlinestatic

Copy() [2/2]

void CISST_EXPORT cmnData< mtsGenericObject >::Copy	(	mtsGenericObject &	data,
		const mtsGenericObject &	source )

DeSerializeBinary()

void cmnData< mtsInterfaceRequiredDescription >::DeSerializeBinary ( DataType & data, std::istream & inputStream, const cmnDataFormat & localFormat, const cmnDataFormat & remoteFormat )

inlinestatic

DeSerializeText()

void cmnData< mtsInterfaceRequiredDescription >::DeSerializeText ( DataType & data, std::istream & inputStream, const char delimiter = ',' )

inlinestatic

HumanReadable()

std::string cmnData< mtsInterfaceRequiredDescription >::HumanReadable ( const DataType & data )

inlinestatic

Scalar()

double cmnData< mtsInterfaceRequiredDescription >::Scalar ( const DataType & data, const size_t index )

inlinestatic

ScalarDescription()

std::string cmnData< mtsInterfaceRequiredDescription >::ScalarDescription ( const DataType & data, const size_t index, const std::string & userDescription = "" )

inlinestatic

ScalarNumber() [1/2]

size_t cmnData< mtsInterfaceRequiredDescription >::ScalarNumber ( const DataType & data )

inlinestatic

ScalarNumber() [2/2]

size_t CISST_EXPORT cmnData< mtsGenericObject >::ScalarNumber

(

const mtsGenericObject &

data

)

ScalarNumberIsFixed() [1/2]

bool cmnData< mtsInterfaceRequiredDescription >::ScalarNumberIsFixed ( const DataType & data )

inlinestatic

ScalarNumberIsFixed() [2/2]

bool CISST_EXPORT cmnData< mtsGenericObject >::ScalarNumberIsFixed

(

const mtsGenericObject &

data

)

SerializeBinary() [1/2]

void cmnData< mtsInterfaceRequiredDescription >::SerializeBinary ( const DataType & data, std::ostream & outputStream )

inlinestatic

SerializeBinary() [2/2]

void CISST_EXPORT cmnData< mtsGenericObject >::SerializeBinary	(	const mtsGenericObject &	data,
		const char	delimiter,
		const std::string &	userDescription )

SerializeDescription()

std::string cmnData< mtsInterfaceRequiredDescription >::SerializeDescription ( const DataType & data, const char delimiter, const std::string & userDescription )

inlinestatic

SerializeText()

void cmnData< mtsInterfaceRequiredDescription >::SerializeText ( const DataType & data, std::ostream & outputStream, const char delimiter = ',' )

inlinestatic

Member Data Documentation

SerializeBinaryByteSize

void static SerializeText(const DataType &data, std::ostream &outputStream, const char delimiter=',') CISST_THROW(std void static DeSerializeText(DataType &data, std::istream &inputStream, const char delimiter=',') CISST_THROW(std void static SerializeBinary(const DataType &data, std::ostream &outputStream) CISST_THROW(std void static DeSerializeBinary(DataType &data, std::istream &inputStream, const cmnDataFormat &localFormat, const cmnDataFormat &remoteFormat) CISST_THROW(std size_t cmnData< mtsInterfaceRequiredDescription >::SerializeBinaryByteSize(const DataType &data)

static

Serializes each element of the data object in text format, separated by the user provided delimiter. Using the previous example, this method would stream the size followed by the 4 value: "4,11,22,33,44". I/O stream errors can lead to exceptions.

Set the value of the data object by deserializing each element from the input stream. The function will look for the user provided delimiter between the elements to deserialize. Using the previous example, the overloaded function for a dynamic vector will look for the size (4), attempt to resize the data vector to fit 4 elements, skip one delimiter (comma) and then attempt to deserialize 4 comma separated values from the input stream.

Serializes each element of the data object in binary format.

Returns the numbers of bytes required to stored the content of the data object. This function can be used to allocate a char buffer used to perform the serialization.

---

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

• tmp/cisst-saw/build/cisst/include/cisstMultiTask/mtsInterfaceCommon.h