PTLib  Version 2.14.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PXMLBase Class Reference

#include <pxml.h>

Inheritance diagram for PXMLBase:
Collaboration diagram for PXMLBase:

Public Types

enum  { DEFAULT_MAX_ENTITY_LENGTH = 4096 }
 
enum  StandAloneType { UninitialisedStandAlone = -2, UnknownStandAlone = -1, NotStandAlone, IsStandAlone }
 
- Public Types inherited from PObject
enum  Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
 Result of the comparison operation performed by the Compare() function. More...
 

Public Member Functions

 P_DECLARE_BITWISE_ENUM_EX (Options, 7,(NoOptions, Indent, IndentWithTabs, NewLineAfterElement, NoIgnoreWhiteSpace, CloseExtended, WithNS, FragmentOnly), AllOptions=(1<<(6+1))-1)
 
 PXMLBase (Options opts=NoOptions)
 
void SetOptions (Options opts)
 
Options GetOptions () const
 
void SetMaxEntityLength (unsigned len)
 
unsigned GetMaxEntityLength () const
 
virtual PBoolean IsNoIndentElement (const PString &) const
 
virtual bool OutputProgress () const
 
bool OutputIndent (ostream &strm, int indent, const PString &elementName=PString::Empty()) const
 
- Public Member Functions inherited from PObject
unsigned GetTraceContextIdentifier () const
 Get PTRACE context identifier. More...
 
void SetTraceContextIdentifier (unsigned id)
 
void GetTraceContextIdentifier (PObject &obj)
 
void GetTraceContextIdentifier (PObject *obj)
 
void SetTraceContextIdentifier (const PObject &obj)
 
void SetTraceContextIdentifier (const PObject *obj)
 
virtual ~PObject ()
 
virtual PObjectClone () const
 Create a copy of the class on the heap. More...
 
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 const char * GetClass (unsigned ancestor=0) const
 Get the current dynamic type of the object instance. More...
 
PBoolean IsClass (const char *cls) const
 
virtual PBoolean InternalIsDescendant (const char *clsName) const
 Determine if the dynamic type of the current instance is a descendent of the specified class. More...
 
__inline const PObjectPTraceObjectInstance () const
 
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 Attributes

Options m_options
 
unsigned m_maxEntityLength
 
- Protected Attributes inherited from PObject
unsigned m_traceContextIdentifier
 

Additional Inherited Members

- Static Public Member Functions inherited from PObject
static const char * Class ()
 Get the name of the class as a C string. More...
 
static __inline const PObjectPTraceObjectInstance (const char *)
 
static __inline const PObjectPTraceObjectInstance (const PObject *obj)
 
static Comparison InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
 Internal function caled from CompareObjectMemoryDirect() More...
 
- Protected Member Functions inherited from PObject
 PObject ()
 Constructor for PObject, made protected so cannot ever create one on its own. More...
 
- Friends inherited from PObject

Member Enumeration Documentation

anonymous enum
Enumerator
DEFAULT_MAX_ENTITY_LENGTH 
Enumerator
UninitialisedStandAlone 
UnknownStandAlone 
NotStandAlone 
IsStandAlone 

Constructor & Destructor Documentation

PXMLBase::PXMLBase ( Options  opts = NoOptions)

Member Function Documentation

unsigned PXMLBase::GetMaxEntityLength ( ) const
inline

References m_maxEntityLength.

Options PXMLBase::GetOptions ( ) const
inline

References m_options.

virtual PBoolean PXMLBase::IsNoIndentElement ( const PString ) const
inlinevirtual

Reimplemented in PXML.

bool PXMLBase::OutputIndent ( ostream &  strm,
int  indent,
const PString elementName = PString::Empty() 
) const
virtual bool PXMLBase::OutputProgress ( ) const
inlinevirtual

Reimplemented in PXML.

PXMLBase::P_DECLARE_BITWISE_ENUM_EX ( Options  ,
,
(NoOptions, Indent, IndentWithTabs, NewLineAfterElement, NoIgnoreWhiteSpace, CloseExtended, WithNS, FragmentOnly)  ,
AllOptions  = (1<<(6+1))-1 
)
void PXMLBase::SetMaxEntityLength ( unsigned  len)
inline

References m_maxEntityLength.

void PXMLBase::SetOptions ( Options  opts)
inline

References m_options.

Member Data Documentation

unsigned PXMLBase::m_maxEntityLength
protected
Options PXMLBase::m_options
protected

Referenced by GetOptions(), and SetOptions().


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