cmnData< std::string > Class Reference

#include <cmnDataFunctionsString.h>

Public Types
typedef std::string	DataType
enum

Public Member Functions
	CMN_DATA_COPY_USING_ASSIGN (std::string)
	CMN_DATA_SERIALIZE_DESCRIPTION (std::string, str)
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 std::string	HumanReadable (const std::string &data)
static size_t	SerializeBinaryByteSize (const DataType &data)
static size_t	SerializeBinary (const DataType &data, char *buffer, size_t bufferSize)
static size_t	DeSerializeBinary (DataType &data, const char *buffer, size_t bufferSize, const cmnDataFormat &localFormat, const cmnDataFormat &remoteFormat)
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 bool	ScalarNumberIsFixed (const std::string &CMN_UNUSED(data))
static size_t	ScalarNumber (const std::string &CMN_UNUSED(data))
static std::string	ScalarDescription (const std::string &CMN_UNUSED(data), const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) CISST_THROW(std
static double	Scalar (const std::string &CMN_UNUSED(data), const size_t CMN_UNUSED(index)) CISST_THROW(std
static std::string	SerializeDescription (const DataType &data, const char delimiter, const std::string &userDescription="")

Member Typedef Documentation

DataType

typedef std::string cmnData< std::string >::DataType

Member Enumeration Documentation

anonymous enum

anonymous enum

Member Function Documentation

CMN_DATA_COPY_USING_ASSIGN()

cmnData< std::string >::CMN_DATA_COPY_USING_ASSIGN

(

std::string

)

CMN_DATA_SERIALIZE_DESCRIPTION()

cmnData< std::string >::CMN_DATA_SERIALIZE_DESCRIPTION	(	std::string	,
		str	)

Copy()

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

DeSerializeBinary() [1/2]

size_t cmnData< std::string >::DeSerializeBinary ( DataType & data, const char * buffer, size_t bufferSize, const cmnDataFormat & localFormat, const cmnDataFormat & remoteFormat )

inlinestatic

DeSerializeBinary() [2/2]

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

inlinestatic

DeSerializeText()

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

inlinestatic

HumanReadable()

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

inlinestatic

Scalar()

double cmnData< std::string >::Scalar ( const std::string & CMN_UNUSEDdata, const size_t CMN_UNUSEDindex )

inlinestatic

ScalarDescription()

std::string cmnData< std::string >::ScalarDescription ( const std::string & CMN_UNUSEDdata, const size_t CMN_UNUSEDindex, const std::string & CMN_UNUSEDuserDescription )

inlinestatic

ScalarNumber() [1/2]

size_t CISST_EXPORT cmnData< mtsGenericObject >::ScalarNumber

(

const mtsGenericObject &

data

)

ScalarNumber() [2/2]

size_t cmnData< std::string >::ScalarNumber ( const std::string & CMN_UNUSEDdata )

inlinestatic

ScalarNumberIsFixed() [1/2]

bool CISST_EXPORT cmnData< mtsGenericObject >::ScalarNumberIsFixed

(

const mtsGenericObject &

data

)

ScalarNumberIsFixed() [2/2]

bool cmnData< std::string >::ScalarNumberIsFixed ( const std::string & CMN_UNUSEDdata )

inlinestatic

SerializeBinary() [1/3]

size_t cmnData< std::string >::SerializeBinary ( const DataType & data, char * buffer, size_t bufferSize )

inlinestatic

SerializeBinary() [2/3]

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

inlinestatic

SerializeBinary() [3/3]

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

SerializeBinaryByteSize()

size_t cmnData< std::string >::SerializeBinaryByteSize ( const DataType & data )

inlinestatic

SerializeDescription()

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

static

Provides a human readble string describing each element of the data object. This description is for all instances of the same "size". For example, if the data object is a dynamic vector of intergers of size 4, the delimiter is a comma and the user description is "V", the returned string would look like "V.size,v[0],v[1],v[2],v[3]".

SerializeText()

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

inlinestatic

---

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

• tmp/cisst-saw/cisst/cisstCommon/cmnDataFunctionsString.h