ipsdk::BaseOArchive Class Reference

Base class for serialization output archives. More...

#include <BaseOArchive.h>

Inheritance diagram for ipsdk::BaseOArchive:

Public Member Functions
virtual void	write (const SerializationOItem< BaseSerializationObject > &item)
	write an object derived of base class More...
virtual void	write (const SerializationOItem< SerializationObjectConstPtr > &item)
	write a shared object derived of base class More...
virtual void	write (const void *ptr, ipUInt_t size)=0
	write raw data to archive More...
Constructors and destructors
	BaseOArchive (bool bIsTextArchive)
virtual	~BaseOArchive ()
virtual void	writeBaseType (const SerializationOItem< ipBool > &item)=0
	write basic type More...
virtual void	writeBaseType (const SerializationOItem< ipInt8 > &item)=0
	write basic type More...
virtual void	writeBaseType (const SerializationOItem< ipUInt8 > &item)=0
	write basic type More...
virtual void	writeBaseType (const SerializationOItem< ipInt16 > &item)=0
	write basic type More...
virtual void	writeBaseType (const SerializationOItem< ipUInt16 > &item)=0
	write basic type More...
virtual void	writeBaseType (const SerializationOItem< ipInt32 > &item)=0
	write basic type More...
virtual void	writeBaseType (const SerializationOItem< ipUInt32 > &item)=0
	write basic type More...
virtual void	writeBaseType (const SerializationOItem< ipInt64 > &item)=0
	write basic type More...
virtual void	writeBaseType (const SerializationOItem< ipUInt64 > &item)=0
	write basic type More...
virtual void	writeBaseType (const SerializationOItem< ipReal32 > &item)=0
	write basic type More...
virtual void	writeBaseType (const SerializationOItem< ipReal64 > &item)=0
	write basic type More...
virtual void	writeBaseType (const SerializationOItem< std::string > &item)=0
	write basic type More...
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 ()
virtual void	archiveHeader ()
	methods allowing to read/write header and footer for an archive More...
virtual void	archiveFooter ()
	methods allowing to read/write header and footer for an archive More...

Protected Types
typedef std::map< std::string, ipUInt32 >	ClassIdMap
	map asociating a class name with an id
typedef std::map< const BaseSerializationObject *, ipUInt32 >	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

Protected Attributes
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 Member Functions inherited from ipsdk::BaseArchive
virtual void	startSubSection (const std::string &subSectionName)
	start/end a new sub section for a archive
virtual void	endSubSection (const std::string &subSectionName)
	start/end a new sub section for a archive

Detailed Description

Base class for serialization output archives.

Author

E. Noirfalise

Date

2013/2/15

Copyright

2013 Reactiv'IP, all right reserved.

Member Function Documentation

write() [1/3]

virtual void ipsdk::BaseOArchive::write ( const SerializationOItem< BaseSerializationObject > &  item )

virtual

write an object derived of base class

Exceptions

ipsdk::IPSDKSerializationException

if an error is detected while writing data

Reimplemented in ipsdk::XmlOArchive.

write() [2/3]

virtual void ipsdk::BaseOArchive::write ( const SerializationOItem< SerializationObjectConstPtr > &  item )

virtual

write a shared object derived of base class

Exceptions

ipsdk::IPSDKSerializationException

if an error is detected while writing data

Reimplemented in ipsdk::XmlOArchive.

writeBaseType() [1/12]

virtual void ipsdk::BaseOArchive::writeBaseType ( const SerializationOItem< ipBool > &  item )

pure virtual

write basic type

Exceptions

ipsdk::IPSDKSerializationException

if an error is detected while writing data

Implemented in ipsdk::XmlOArchive, and ipsdk::BinaryOArchive.

writeBaseType() [2/12]

virtual void ipsdk::BaseOArchive::writeBaseType ( const SerializationOItem< ipInt8 > &  item )

pure virtual

write basic type

Exceptions

ipsdk::IPSDKSerializationException

if an error is detected while writing data

Implemented in ipsdk::XmlOArchive, and ipsdk::BinaryOArchive.

writeBaseType() [3/12]

virtual void ipsdk::BaseOArchive::writeBaseType ( const SerializationOItem< ipUInt8 > &  item )

pure virtual

write basic type

Exceptions

ipsdk::IPSDKSerializationException

if an error is detected while writing data

Implemented in ipsdk::XmlOArchive, and ipsdk::BinaryOArchive.

writeBaseType() [4/12]

virtual void ipsdk::BaseOArchive::writeBaseType ( const SerializationOItem< ipInt16 > &  item )

pure virtual

write basic type

Exceptions

ipsdk::IPSDKSerializationException

if an error is detected while writing data

Implemented in ipsdk::XmlOArchive, and ipsdk::BinaryOArchive.

writeBaseType() [5/12]

virtual void ipsdk::BaseOArchive::writeBaseType ( const SerializationOItem< ipUInt16 > &  item )

pure virtual

write basic type

Exceptions

ipsdk::IPSDKSerializationException

if an error is detected while writing data

Implemented in ipsdk::XmlOArchive, and ipsdk::BinaryOArchive.

writeBaseType() [6/12]

virtual void ipsdk::BaseOArchive::writeBaseType ( const SerializationOItem< ipInt32 > &  item )

pure virtual

write basic type

Exceptions

ipsdk::IPSDKSerializationException

if an error is detected while writing data

Implemented in ipsdk::XmlOArchive, and ipsdk::BinaryOArchive.

writeBaseType() [7/12]

virtual void ipsdk::BaseOArchive::writeBaseType ( const SerializationOItem< ipUInt32 > &  item )

pure virtual

write basic type

Exceptions

ipsdk::IPSDKSerializationException

if an error is detected while writing data

Implemented in ipsdk::XmlOArchive, and ipsdk::BinaryOArchive.

writeBaseType() [8/12]

virtual void ipsdk::BaseOArchive::writeBaseType ( const SerializationOItem< ipInt64 > &  item )

pure virtual

write basic type

Exceptions

ipsdk::IPSDKSerializationException

if an error is detected while writing data

Implemented in ipsdk::XmlOArchive, and ipsdk::BinaryOArchive.

writeBaseType() [9/12]

virtual void ipsdk::BaseOArchive::writeBaseType ( const SerializationOItem< ipUInt64 > &  item )

pure virtual

write basic type

Exceptions

ipsdk::IPSDKSerializationException

if an error is detected while writing data

Implemented in ipsdk::XmlOArchive, and ipsdk::BinaryOArchive.

writeBaseType() [10/12]

virtual void ipsdk::BaseOArchive::writeBaseType ( const SerializationOItem< ipReal32 > &  item )

pure virtual

write basic type

Exceptions

ipsdk::IPSDKSerializationException

if an error is detected while writing data

Implemented in ipsdk::XmlOArchive, and ipsdk::BinaryOArchive.

writeBaseType() [11/12]

virtual void ipsdk::BaseOArchive::writeBaseType ( const SerializationOItem< ipReal64 > &  item )

pure virtual

write basic type

Exceptions

ipsdk::IPSDKSerializationException

if an error is detected while writing data

Implemented in ipsdk::XmlOArchive, and ipsdk::BinaryOArchive.

writeBaseType() [12/12]

virtual void ipsdk::BaseOArchive::writeBaseType ( const SerializationOItem< std::string > &  item )

pure virtual

write basic type

Exceptions

ipsdk::IPSDKSerializationException

if an error is detected while writing data

Implemented in ipsdk::XmlOArchive, and ipsdk::BinaryOArchive.

write() [3/3]

virtual void ipsdk::BaseOArchive::write ( const void *  ptr, ipUInt_t  size  )

pure virtual

write raw data to archive

Parameters

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

Exceptions

ipsdk::IPSDKSerializationException

if an error is detected while writing data

Implemented in ipsdk::XmlOArchive, and ipsdk::BinaryOArchive.

---

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/BaseOArchive.h