ERC CISST - cisst software

---

cmnDeSerializer.h File Reference

---

Detailed Description

Declaration of cmnDeSerializer and functions cmnDeSerializeRaw.

Definition in file cmnDeSerializer.h.

#include <cisstCommon/cmnPortability.h>
#include <cisstCommon/cmnTypeTraits.h>
#include <cisstCommon/cmnGenericObject.h>
#include <cisstCommon/cmnClassRegister.h>
#include <cisstCommon/cmnThrow.h>
#include <cisstCommon/cmnAssert.h>
#include <string>
#include <fstream>
#include <map>
#include <cstddef>
#include <cisstCommon/cmnExport.h>

Include dependency graph for cmnDeSerializer.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

• class cmnDeSerializer

  De-serialization utility class. More...
  

Functions

• template<class _elementType> void cmnDeSerializeRaw (std::istream &inputStream, _elementType &data) throw (std::runtime_error)
• void cmnDeSerializeSizeRaw (std::istream &inputStream, size_t &data) throw (std::runtime_error)
• void cmnDeSerializeRaw (std::istream &inputStream, std::string &data) throw (std::runtime_error)

---

Function Documentation

void cmnDeSerializeRaw	(	std::istream &	inputStream,
		std::string &	data
	)			throw (std::runtime_error) [inline]

De-serialization helper function for an STL string. This function first de-serializes the string size, resize the string and then replaces its content with the result of read from the input stream. If the read operation fails, an exception is thrown (std::runtime_error).

Definition at line 95 of file cmnDeSerializer.h.

References cmnDeSerializeSizeRaw(), and cmnThrow().

template<class _elementType>

void cmnDeSerializeRaw	(	std::istream &	inputStream,
		_elementType &	data
	)			throw (std::runtime_error) [inline]

De-serialization helper function for a basic type. This function performs a cast to char pointer (char *) using reinterpret_cast and then replace the data with the result of read from the input stream. If the read operation fails, an exception is thrown (std::runtime_error).

This function should be use to implement the DeSerializeRaw method of classes derived from cmnGenericObject.

Definition at line 58 of file cmnDeSerializer.h.

References cmnThrow().

Referenced by cmnDeSerializeSizeRaw(), cmnDeSerializer::DeSerialize(), vctFixedSizeVector< svlImageProcessing::Internals, SVL_MAX_CHANNELS >::DeSerializeRaw(), vctFixedSizeMatrixBase< _rows, _cols, _rowMajor?_cols:1, _rowMajor?1:_rows, double, vctFixedSizeMatrixTraits< double, _rows, _cols, _rowMajor?_cols:1, _rowMajor?1:_rows >::array >::DeSerializeRaw(), vctDynamicVectorRef< CISSTNETLIB_DOUBLE >::DeSerializeRaw(), vctDynamicVector< svlSample * >::DeSerializeRaw(), vctDynamicMatrixRef< CISSTNETLIB_DOUBLE >::DeSerializeRaw(), vctDynamicMatrix< svlTarget2D >::DeSerializeRaw(), vctAxisAngleRotation3< _elementType >::DeSerializeRaw(), vctAngleRotation2::DeSerializeRaw(), svlSampleMatrixCustom< _ValueType >::DeSerializeRaw(), svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >::DeSerializeRaw(), mtsGenericObjectProxyRef< _elementType >::DeSerializeRaw(), mtsGenericObjectProxy< _elementType >::DeSerializeRaw(), and cmnGenericObjectProxy< _elementType >::DeSerializeRaw().

void cmnDeSerializeSizeRaw	(	std::istream &	inputStream,
		size_t &	data
	)			throw (std::runtime_error) [inline]

De-serialization helper function for STL size object. This function converts a serialized size (unsigned long long int) to the host size_t object. This operation is required for all size_t as the writer/reader can be both 32 bits or 64 bits programs.

This function should be use to implement the DeSerializeRaw method of classes derived from cmnGenericObject.

Definition at line 77 of file cmnDeSerializer.h.

References cmnDeSerializeRaw(), and cmnThrow().

Referenced by cmnDeSerializeRaw(), vctDynamicMatrix< svlTarget2D >::DeSerializeRaw(), and vctDynamicVector< svlSample * >::DeSerializeRaw().

---