#include <pxml.h>

Inheritance diagram for PXMLObject:

Collaboration diagram for PXMLObject:

Public Member Functions
PXMLElement *	GetParent () const

bool	SetParent (PXMLElement *parent)

virtual PINDEX	GetObjectCount () const

PXMLObject *	GetNextObject () const

PString	AsString () const

virtual void	Output (ostream &strm, const PXMLBase &xml, int indent) const =0

virtual PBoolean	IsElement () const =0

void	SetDirty ()

bool	IsDirty () const

void	GetFilePosition (unsigned &col, unsigned &line) const

void	SetFilePosition (unsigned col, unsigned line)

virtual PXMLObject *	Clone () const =0
	Create a copy of the class on the heap. More...

Public Member Functions inherited from PObject
__inline unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...

__inline void	SetTraceContextIdentifier (unsigned id)

__inline void	SetTraceContextIdentifier (const PObject &obj)

__inline void	SetTraceContextIdentifier (const PObject *obj)

__inline void	CopyTraceContextIdentifier (PObject &obj) const

__inline void	CopyTraceContextIdentifier (PObject *obj) const

virtual	~PObject ()

__inline const char *	GetClass () const

__inline bool	IsClass (const char *name) const

__inline const PObject *	PTraceObjectInstance () const

template<class CLS >
CLS *	CloneAs () const
	As for Clone() but converts to specified type. More...

virtual PINDEX	HashFunction () const
	This function yields a hash value required by the `PDictionary` class. More...

virtual Comparison	Compare (const PObject &obj) const
	Compare the two objects and return their relative rank. More...

virtual Comparison	CompareObjectMemoryDirect (const PObject &obj) const
	Determine the byte wise comparison of two objects. More...

bool	operator== (const PObject &obj) const
	Compare the two objects. More...

bool	operator!= (const PObject &obj) const
	Compare the two objects. More...

bool	operator< (const PObject &obj) const
	Compare the two objects. More...

bool	operator> (const PObject &obj) const
	Compare the two objects. More...

bool	operator<= (const PObject &obj) const
	Compare the two objects. More...

bool	operator>= (const PObject &obj) const
	Compare the two objects. More...

virtual void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...

virtual void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

Protected Member Functions
	PXMLObject ()

	P_REMOVE_VIRTUAL (PXMLObject , Clone(PXMLElement ) const, 0)

Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Protected Attributes
PXMLElement *	m_parent

bool	m_dirty

unsigned	m_lineNumber

unsigned	m_column

Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Additional Inherited Members
Public Types inherited from PObject
enum	Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
	Result of the comparison operation performed by the `Compare()` function. More...

Static Public Member Functions inherited from PObject
static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject *from)

static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject to, const PObject from)

static __inline const char *	Class ()

static __inline const PObject *	PTraceObjectInstance (const char *)

static __inline const PObject *	PTraceObjectInstance (const PObject *obj)

template<typename T >
static Comparison	Compare2 (T v1, T v2)
	Compare two types, returning Comparison type. More...

static Comparison	InternalCompareObjectMemoryDirect (const PObject obj1, const PObject obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...

Constructor & Destructor Documentation

PXMLObject::PXMLObject ( )

protected

Member Function Documentation

PString PXMLObject::AsString ( ) const

virtual PXMLObject* PXMLObject::Clone ( ) const

pure virtual

Create a copy of the class on the heap.

The exact semantics of the descendent class determine what is required to make a duplicate of the instance. Not all classes can even do a clone operation.

The main user of the clone function is the PDictionary class as it requires copies of the dictionary keys.

The default behaviour is for this function to assert.

Returns: pointer to new copy of the class instance.

Reimplemented from PObject.

Implemented in PXMLElement, and PXMLData.

void PXMLObject::GetFilePosition	(	unsigned &	col,
		unsigned &	line
	)		const

inline

References m_column, and m_lineNumber.

PXMLObject* PXMLObject::GetNextObject ( ) const

virtual PINDEX PXMLObject::GetObjectCount ( ) const

inlinevirtual

Reimplemented in PXMLElement.

PXMLElement* PXMLObject::GetParent ( ) const

inline

References m_parent.

bool PXMLObject::IsDirty ( ) const

inline

References m_dirty.

virtual PBoolean PXMLObject::IsElement ( ) const

pure virtual

Implemented in PXMLElement, and PXMLData.

virtual void PXMLObject::Output	(	ostream &	strm,
		const PXMLBase &	xml,
		int	indent
	)		const

pure virtual

Implemented in PXMLElement, and PXMLData.

PXMLObject::P_REMOVE_VIRTUAL	(	PXMLObject *	,
		Clone(PXMLElement *)	const,
		0
	)

protected

void PXMLObject::SetDirty ( )

void PXMLObject::SetFilePosition	(	unsigned	col,
		unsigned	line
	)

inline

References m_column, and m_lineNumber.

bool PXMLObject::SetParent ( PXMLElement * parent )

Member Data Documentation

unsigned PXMLObject::m_column

protected

Referenced by GetFilePosition(), and SetFilePosition().

bool PXMLObject::m_dirty

protected

Referenced by IsDirty().

unsigned PXMLObject::m_lineNumber

protected

Referenced by GetFilePosition(), and SetFilePosition().

PXMLElement* PXMLObject::m_parent

protected

Referenced by GetParent().

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

pxml.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation