PTLib  Version 2.18.8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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...
 
AttribDictGetAttributes ()
 
const AttribDictGetAttributes () const
 
PLDAPAttributeBaseGetAttribute (const char *name) const
 
void AddAttribute (PLDAPAttributeBase *var)
 
- 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 PObjectPTraceObjectInstance () const
 
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 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 ReadFrom (istream &strm)
 Input the contents of the object from the stream. More...
 

Static Public Member Functions

static PLDAPStructBaseGetInitialiser ()
 
- 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 PObjectPTraceObjectInstance (const char *)
 
static __inline const PObjectPTraceObjectInstance (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...
 

Protected Member Functions

 PLDAPStructBase ()
 
PLDAPStructBaseoperator= (const PLDAPStructBase &)
 
PLDAPStructBaseoperator= (const PStringArray &array)
 
PLDAPStructBaseoperator= (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 m_attributes
 
PLDAPStructBasem_initialiserStack
 
- Protected Attributes inherited from PObject
unsigned m_traceContextIdentifier
 

Static Protected Attributes

static PMutex m_initialiserMutex
 
static PLDAPStructBasem_initialiserInstance
 

Member Typedef Documentation

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
AttribDict& PLDAPStructBase::GetAttributes ( )
inline

References m_attributes.

const AttribDict& PLDAPStructBase::GetAttributes ( ) const
inline

References m_attributes.

static PLDAPStructBase& PLDAPStructBase::GetInitialiser ( )
inlinestatic
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::m_attributes
protected

Referenced by GetAttribute(), and GetAttributes().

PLDAPStructBase* PLDAPStructBase::m_initialiserInstance
staticprotected

Referenced by GetInitialiser().

PMutex PLDAPStructBase::m_initialiserMutex
staticprotected
PLDAPStructBase* PLDAPStructBase::m_initialiserStack
protected

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