Class for input part of xml serialisation. More...

#include <XmlIArchive.h>

Inheritance diagram for ipsdk::XmlIArchive:

Public Member Functions
std::istream &	getStream () const
	get underlying serialization stream

void	read (const SerializationIItem< BaseSerializationObject > &item)
	read an object derived of base class from stream More...

void	read (const SerializationIItem< SerializationObjectPtr > &item)
	read a shared object derived of base class More...

void	read (void *ptr, ipUInt_t size)
	read raw data from archive More...

Constructors and destructors
	XmlIArchive (std::istream &stream)

	~XmlIArchive ()


void	archiveHeader ()
	methods allowing to read/write header and footer for an archive More...

void	archiveFooter ()
	methods allowing to read/write header and footer for an archive More...


void	readBaseType (const SerializationIItem< ipBool > &item)
	read basic type from stream More...

void	readBaseType (const SerializationIItem< ipInt8 > &item)
	read basic type from stream More...

void	readBaseType (const SerializationIItem< ipUInt8 > &item)
	read basic type from stream More...

void	readBaseType (const SerializationIItem< ipInt16 > &item)
	read basic type from stream More...

void	readBaseType (const SerializationIItem< ipUInt16 > &item)
	read basic type from stream More...

void	readBaseType (const SerializationIItem< ipInt32 > &item)
	read basic type from stream More...

void	readBaseType (const SerializationIItem< ipUInt32 > &item)
	read basic type from stream More...

void	readBaseType (const SerializationIItem< ipInt64 > &item)
	read basic type from stream More...

void	readBaseType (const SerializationIItem< ipUInt64 > &item)
	read basic type from stream More...

void	readBaseType (const SerializationIItem< ipReal32 > &item)
	read basic type from stream More...

void	readBaseType (const SerializationIItem< ipReal64 > &item)
	read basic type from stream More...

void	readBaseType (const SerializationIItem< std::string > &item)
	read basic type from stream More...

Public Member Functions inherited from ipsdk::BaseIArchive
	BaseIArchive (bool bIsTextArchive)

virtual	~BaseIArchive ()

Public Member Functions inherited from ipsdk::BaseArchive
bool	isTextArchive () const
	method allowing to test whether archive is an human readable text archive

bool	isClassVersionRegistred (const std::string &className) const
	check whether a class version has already been registred

void	registerClassVersion (const std::string &className, ipUInt32 version)
	register a class version More...

ipUInt32	getRegisterClassVersion (const std::string &className) const
	get registered class version More...

virtual Guid	getSocketGuid () const
	retrieve socket guid associated to archive remote computer

	BaseArchive (bool bIsTextArchive)

virtual	~BaseArchive ()

Protected Member Functions
template<typename T >
void	readBaseData (const SerializationIItem< T > &item)
	template method for reading base type data More...


void	startSubSection (const std::string &subSectionName)
	start/end a new sub section for archive

void	endSubSection (const std::string &subSectionName)
	start/end a new sub section for archive

Protected Attributes
ipUInt64	_curLineIdx
	current archive line index

std::string	_strTabInc
	current tab increment for archive

std::istream &	_stream
	underlying serialization stream

Protected Attributes inherited from ipsdk::BaseIArchive
ClassIdMap	_classIdMap
	class to id map for class serialization

SharedPtrMap	_sharedPtrMap
	map for shared serializable objects allowing reference counting update

Protected Attributes inherited from ipsdk::BaseArchive
ClassVersionMap	_classVersionMap
	map for class name / class version association

bool	_bIsTextArchive
	flag indicating whether archive is an human readable text archive

Additional Inherited Members
Protected Types inherited from ipsdk::BaseIArchive
typedef std::map< ipUInt32, std::string >	ClassIdMap
	map associating an id to a class name

typedef std::map< ipUInt32, SerializationObjectWeakPtr >	SharedPtrMap
	map for shared serializable objects

Protected Types inherited from ipsdk::BaseArchive
typedef std::map< std::string, ipUInt32 >	ClassVersionMap
	map associating a class name to its id

Detailed Description

Class for input part of xml serialisation.

Author: E. Noirfalise

Date: 2013/2/15

Copyright: 2013 Reactiv'IP, all right reserved.

Member Function Documentation

◆ archiveHeader()

void ipsdk::XmlIArchive::archiveHeader ( )

virtual

methods allowing to read/write header and footer for an archive

Exceptions

ipsdk::IPSDKSerializationException if an error is detected while reading data

Reimplemented from ipsdk::BaseArchive.

◆ archiveFooter()

void ipsdk::XmlIArchive::archiveFooter ( )

virtual

methods allowing to read/write header and footer for an archive

Exceptions

ipsdk::IPSDKSerializationException if an error is detected while reading data

Reimplemented from ipsdk::BaseArchive.

◆ read() [1/3]

void ipsdk::XmlIArchive::read ( const SerializationIItem< BaseSerializationObject > & item )

virtual

read an object derived of base class from stream

Exceptions

ipsdk::IPSDKSerializationException if an error is detected while reading data

Reimplemented from ipsdk::BaseIArchive.

◆ read() [2/3]

void ipsdk::XmlIArchive::read ( const SerializationIItem< SerializationObjectPtr > & item )

virtual

read a shared object derived of base class

Exceptions

ipsdk::IPSDKSerializationException if an error is detected while reading data

Reimplemented from ipsdk::BaseIArchive.

◆ readBaseType() [1/12]

void ipsdk::XmlIArchive::readBaseType ( const SerializationIItem< ipBool > & item )

virtual

read basic type from stream

Exceptions

ipsdk::IPSDKSerializationException if an error is detected while reading data

Implements ipsdk::BaseIArchive.

◆ readBaseType() [2/12]

void ipsdk::XmlIArchive::readBaseType ( const SerializationIItem< ipInt8 > & item )

virtual

read basic type from stream

Exceptions

ipsdk::IPSDKSerializationException if an error is detected while reading data

Implements ipsdk::BaseIArchive.

◆ readBaseType() [3/12]

void ipsdk::XmlIArchive::readBaseType ( const SerializationIItem< ipUInt8 > & item )

virtual

read basic type from stream

Exceptions

ipsdk::IPSDKSerializationException if an error is detected while reading data

Implements ipsdk::BaseIArchive.

◆ readBaseType() [4/12]

void ipsdk::XmlIArchive::readBaseType ( const SerializationIItem< ipInt16 > & item )

virtual

read basic type from stream

Exceptions

ipsdk::IPSDKSerializationException if an error is detected while reading data

Implements ipsdk::BaseIArchive.

◆ readBaseType() [5/12]

void ipsdk::XmlIArchive::readBaseType ( const SerializationIItem< ipUInt16 > & item )

virtual

read basic type from stream

Exceptions

ipsdk::IPSDKSerializationException if an error is detected while reading data

Implements ipsdk::BaseIArchive.

◆ readBaseType() [6/12]

void ipsdk::XmlIArchive::readBaseType ( const SerializationIItem< ipInt32 > & item )

virtual

read basic type from stream

Exceptions

ipsdk::IPSDKSerializationException if an error is detected while reading data

Implements ipsdk::BaseIArchive.

◆ readBaseType() [7/12]

void ipsdk::XmlIArchive::readBaseType ( const SerializationIItem< ipUInt32 > & item )

virtual

read basic type from stream

Exceptions

ipsdk::IPSDKSerializationException if an error is detected while reading data

Implements ipsdk::BaseIArchive.

◆ readBaseType() [8/12]

void ipsdk::XmlIArchive::readBaseType ( const SerializationIItem< ipInt64 > & item )

virtual

read basic type from stream

Exceptions

ipsdk::IPSDKSerializationException if an error is detected while reading data

Implements ipsdk::BaseIArchive.

◆ readBaseType() [9/12]

void ipsdk::XmlIArchive::readBaseType ( const SerializationIItem< ipUInt64 > & item )

virtual

read basic type from stream

Exceptions

ipsdk::IPSDKSerializationException if an error is detected while reading data

Implements ipsdk::BaseIArchive.

◆ readBaseType() [10/12]

void ipsdk::XmlIArchive::readBaseType ( const SerializationIItem< ipReal32 > & item )

virtual

read basic type from stream

Exceptions

ipsdk::IPSDKSerializationException if an error is detected while reading data

Implements ipsdk::BaseIArchive.

◆ readBaseType() [11/12]

void ipsdk::XmlIArchive::readBaseType ( const SerializationIItem< ipReal64 > & item )

virtual

read basic type from stream

Exceptions

ipsdk::IPSDKSerializationException if an error is detected while reading data

Implements ipsdk::BaseIArchive.

◆ readBaseType() [12/12]

void ipsdk::XmlIArchive::readBaseType ( const SerializationIItem< std::string > & item )

virtual

read basic type from stream

Exceptions

ipsdk::IPSDKSerializationException if an error is detected while reading data

Implements ipsdk::BaseIArchive.

◆ read() [3/3]

void ipsdk::XmlIArchive::read	(	void *	ptr,
		ipUInt_t	size
	)

virtual

read raw data from archive

Parameters

size	buffer size expressed in octets
ptr	buffer used to store read data

Exceptions

ipsdk::IPSDKSerializationException if an error is detected while reading data

Implements ipsdk::BaseIArchive.

◆ readBaseData()

template<typename T >

void ipsdk::XmlIArchive::readBaseData ( const SerializationIItem< T > & item )

protected

template method for reading base type data

Exceptions

ipsdk::IPSDKSerializationException if an error is detected while reading data

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKSerialization/Archive/XmlIArchive.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ archiveHeader()

◆ archiveFooter()

◆ read() [1/3]

◆ read() [2/3]

◆ readBaseType() [1/12]

◆ readBaseType() [2/12]

◆ readBaseType() [3/12]

◆ readBaseType() [4/12]

◆ readBaseType() [5/12]

◆ readBaseType() [6/12]

◆ readBaseType() [7/12]

◆ readBaseType() [8/12]

◆ readBaseType() [9/12]

◆ readBaseType() [10/12]

◆ readBaseType() [11/12]

◆ readBaseType() [12/12]

◆ read() [3/3]

◆ readBaseData()