PLDAPStructBase Class Reference

#include <pldap.h>

Inheritance diagram for PLDAPStructBase:

Collaboration diagram for PLDAPStructBase:

Public Types
typedef PDictionary< PString, PLDAPAttributeBase >	AttribDict
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
void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...
AttribDict &	GetAttributes ()
const AttribDict &	GetAttributes () const
PLDAPAttributeBase *	GetAttribute (const char *name) const
void	AddAttribute (PLDAPAttributeBase *var)
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 PObject *	Clone () 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 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 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 PObject *	PTraceObjectInstance () const
virtual void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

Static Public Member Functions
static PLDAPStructBase &	GetInitialiser ()
Static Public Member Functions inherited from PObject
static Comparison	InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...
static const char *	Class ()
	Get the name of the class as a C string. More...
static __inline const PObject *	PTraceObjectInstance (const char *)
static __inline const PObject *	PTraceObjectInstance (const PObject *obj)

Protected Member Functions
	PLDAPStructBase ()
PLDAPStructBase &	operator= (const PLDAPStructBase &)
PLDAPStructBase &	operator= (const PStringArray &array)
PLDAPStructBase &	operator= (const PStringToString &dict)
void	EndConstructor ()
Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Protected Attributes
AttribDict	attributes
PLDAPStructBase *	initialiserStack
Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Static Protected Attributes
static PMutex	initialiserMutex
static PLDAPStructBase *	initialiserInstance

Member Typedef Documentation

typedef PDictionary<PString, PLDAPAttributeBase> PLDAPStructBase::AttribDict

Constructor & Destructor Documentation

PLDAPStructBase::PLDAPStructBase ( )

protected

Member Function Documentation

void PLDAPStructBase::AddAttribute

(

PLDAPAttributeBase *

var

)

void PLDAPStructBase::EndConstructor ( )

protected

PLDAPAttributeBase* PLDAPStructBase::GetAttribute ( const char *  name ) const

inline

References attributes, and PDictionary< K, D >::GetAt().

AttribDict& PLDAPStructBase::GetAttributes ( )

inline

References attributes.

const AttribDict& PLDAPStructBase::GetAttributes ( ) const

inline

References attributes.

static PLDAPStructBase& PLDAPStructBase::GetInitialiser ( )

inlinestatic

References initialiserInstance, and PAssertNULL.

PLDAPStructBase& PLDAPStructBase::operator= ( const PLDAPStructBase &  )

protected

PLDAPStructBase& PLDAPStructBase::operator= ( const PStringArray &  array )

protected

PLDAPStructBase& PLDAPStructBase::operator= ( const PStringToString &  dict )

protected

void PLDAPStructBase::PrintOn ( ostream &  strm ) const

virtual

Output the contents of the object to the stream.

The exact output is dependent on the exact semantics of the descendent class. This is primarily used by the standard operator<< function.

The default behaviour is to print the class name.

Reimplemented from PObject.

Member Data Documentation

AttribDict PLDAPStructBase::attributes

protected

Referenced by GetAttribute(), and GetAttributes().

PLDAPStructBase* PLDAPStructBase::initialiserInstance

staticprotected

Referenced by GetInitialiser().

PMutex PLDAPStructBase::initialiserMutex

staticprotected

PLDAPStructBase* PLDAPStructBase::initialiserStack

protected

---

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

• pldap.h