IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Member Functions | Protected Types | Protected Attributes | Friends | List of all members
ipsdk::BaseArchive Class Reference

Base class for serialization archives. More...

#include <BaseArchive.h>

Inheritance diagram for ipsdk::BaseArchive:
ipsdk::BaseIArchive ipsdk::BaseOArchive ipsdk::BinaryIArchive ipsdk::XmlIArchive ipsdk::BinaryOArchive ipsdk::XmlOArchive

Public Member Functions

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
 
Constructors and destructors
 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, ipUInt32ClassVersionMap
 map associating a class name to its id
 

Protected Member Functions

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
 

Protected Attributes

ClassVersionMap _classVersionMap
 map for class name / class version association
 
bool _bIsTextArchive
 flag indicating whether archive is an human readable text archive
 

Friends

class ArchiveSectionManager
 

Detailed Description

Base class for serialization archives.

Author
E. Noirfalise
Date
2013/2/15

Member Function Documentation

◆ archiveHeader()

virtual void ipsdk::BaseArchive::archiveHeader ( )
inlinevirtual

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

Exceptions
ipsdk::IPSDKSerializationExceptionif read/write error on archive

Reimplemented in ipsdk::XmlIArchive, ipsdk::XmlOArchive, ipsdk::BinaryIArchive, and ipsdk::BinaryOArchive.

◆ archiveFooter()

virtual void ipsdk::BaseArchive::archiveFooter ( )
inlinevirtual

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

Exceptions
ipsdk::IPSDKSerializationExceptionif read/write error on archive

Reimplemented in ipsdk::XmlIArchive, ipsdk::XmlOArchive, ipsdk::BinaryIArchive, and ipsdk::BinaryOArchive.

◆ registerClassVersion()

void ipsdk::BaseArchive::registerClassVersion ( const std::string &  className,
ipUInt32  version 
)

register a class version

Exceptions
ipsdk::IPSDKSerializationExceptionif isClassVersionRegistred(className) == true

◆ getRegisterClassVersion()

ipUInt32 ipsdk::BaseArchive::getRegisterClassVersion ( const std::string &  className) const

get registered class version

Exceptions
ipsdk::IPSDKSerializationExceptionif isClassVersionRegistred(className) == false

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