Globally unique ID definition.
Inheritance:
Public Methods
| Construction
|
| Overrides from PObject
|
| Operations
|
Documentation
Globally unique ID definition.
This implements a 128 bit globally unique ID as required by many protocols
and software systems. The value is constructed in such a way as to make a
duplicate anywhere in the world highly unlikely.
Construction
OpalGloballyUniqueID()
- Create a new ID.
The ID created with this will be initialised to a globally unique ID
as per specification.
OpalGloballyUniqueID( const char* cstr )
- Create an ID from a C string of hex (as produced by AsString()).
A useful construct is to construct a OpalGloballyUniqueID() with
NULL which produces an all zero GUID, etectable with the isNULL()
function.
- Parameters:
- cstr - C string to convert
OpalGloballyUniqueID( const PString & str )
- Create an ID from a PString of hex (as produced by AsString()).
- Parameters:
- str - String of hex to convert
OpalGloballyUniqueID( const PASN_OctetString & ostr )
- Create an ID from an octet string in an ASN PDU.
- Parameters:
- ostr - Octet string from ASN to convert
Overrides from PObject
virtual void PrintOn( ostream & strm ) const
- Standard stream print function.
The PObject class has a << operator defined that calls this function
polymorphically.
- Parameters:
- strm - Stream to output text representation
virtual void ReadFrom( istream & strm )
- Standard stream read function.
The PObject class has a >> operator defined that calls this function
polymorphically.
- Parameters:
- strm - Stream to output text representation
virtual PObject* Clone() const
- Create a clone of the ID.
The duplicate ID has the same value as the source. Required for having
this object as a key in dictionaries.
virtual PINDEX HashFunction() const
- Get the hash value for the ID.
Creates a number based on the ID value for use in the hash table of
a dictionary. Required for having this object as a key in dictionaries.
Operations
PString AsString() const
- Convert the ID to human readable string
BOOL IsNULL() const
- Test if the GUID is null, ie consists of all zeros
- This class has no child classes.
Alphabetic index HTML hierarchy of classes or Java
This page was generated with the help of DOC++.