agxStream::Archive Class Reference

Abstract base class for input/output storage of Serializable classes. More...

#include <Archive.h>

Inheritance diagram for agxStream::Archive:

Classes
class	ScopedSection
	Ties a beginSecion/endSection pair to a scope. More...

Public Member Functions
	Archive ()
virtual void	beginSection (const char *)=0
virtual void	close ()
virtual void	endSection (const char *)=0
bool	getBinaryMode () const
bool	isOpen () const
virtual void	newAttribute ()
	Called whenever a new item is initiated.
void	setBinaryMode (bool m)
Public Member Functions inherited from agx::Referenced
	Referenced ()
	Default constructor.
	Referenced (const Referenced &)
template<typename T >
T *	as ()
	Subclass casting.
template<typename T >
const T *	as () const
template<typename T >
T *	asSafe ()
	Safe subclass casting, return nullptr if template type does not match.
template<typename T >
const T *	asSafe () const
int	getReferenceCount () const
template<typename T >
bool	is () const
	Subclass test.
Referenced &	operator= (const Referenced &)
	Assignment operator. Will increment the number of references to the referenced object.
void	reference (void *ptr=nullptr) const
	Explicitly increment the reference count by one, indicating that this object has another pointer which is referencing it.
void	unreference (void *ptr=nullptr) const
	Decrement the reference count by one, indicating that a pointer to this object is referencing it.
void	unreference_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is referencing it.

Protected Member Functions
virtual	~Archive ()
	Destructor.
void	open ()
Protected Member Functions inherited from agx::Referenced
virtual	~Referenced ()
	Destructor.
void	allocateObserverVector () const
void	deleteUsingDeleteHandler () const

Protected Attributes
bool	m_isOpen
Protected Attributes inherited from agx::Referenced
Mutex	m_mutex
ObserverContainer	m_observers
AtomicValue	m_refCount

Additional Inherited Members
Static Public Member Functions inherited from agx::Referenced
template<typename T >
static bool	ValidateCast (const Referenced *object)
Static Protected Member Functions inherited from agx::Referenced
static DeleteHandler *	getDeleteHandler ()
static void	setDeleteHandler (DeleteHandler *handler)
	Internal: Set a DeleteHandler to which deletion of all referenced counted objects will be delegated to.

Detailed Description

Abstract base class for input/output storage of Serializable classes.

Definition at line 55 of file Archive.h.

Constructor & Destructor Documentation

Archive()

agxStream::Archive::Archive ( )

inline

Definition at line 58 of file Archive.h.

~Archive()

virtual agxStream::Archive::~Archive ( )

inlineprotectedvirtual

Destructor.

Definition at line 113 of file Archive.h.

Member Function Documentation

beginSection()

virtual void agxStream::Archive::beginSection ( const char *  )

pure virtual

Implemented in agxStream::OutputArchive, agxStream::XMLInputArchive, agxStream::XMLOutputArchive, and agxStream::InputArchive.

close()

virtual void agxStream::Archive::close ( )

inlinevirtual

Reimplemented in agxStream::XMLOutputArchive, and agxStream::OutputArchive.

Definition at line 78 of file Archive.h.

endSection()

virtual void agxStream::Archive::endSection ( const char *  )

pure virtual

Implemented in agxStream::OutputArchive, agxStream::XMLInputArchive, agxStream::XMLOutputArchive, and agxStream::InputArchive.

getBinaryMode()

bool agxStream::Archive::getBinaryMode ( ) const

inline

Returns

true if archive is used in binary mode

Definition at line 61 of file Archive.h.

isOpen()

bool agxStream::Archive::isOpen ( ) const

inline

Returns

true if archive is open for reading/writing

Definition at line 74 of file Archive.h.

newAttribute()

virtual void agxStream::Archive::newAttribute ( )

inlinevirtual

Called whenever a new item is initiated.

Definition at line 71 of file Archive.h.

open()

void agxStream::Archive::open ( )

inlineprotected

Definition at line 116 of file Archive.h.

setBinaryMode()

void agxStream::Archive::setBinaryMode ( bool  m )

inline

Parameters

m	- If true this archive is used in binary mode

Definition at line 66 of file Archive.h.

Member Data Documentation

m_isOpen

bool agxStream::Archive::m_isOpen

protected

Definition at line 120 of file Archive.h.

---

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

• Archive.h