Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Examples  

corelinux::UniversalIdentifier Class Reference

#include <UniversalIdentifier.hpp>

Inheritance diagram for corelinux::UniversalIdentifier:

corelinux::Identifier List of all members.

Public Methods

 UniversalIdentifier ( void )
 Default constructor.

 UniversalIdentifier ( UniversalIdentifierCref )
 Constructs from structure.

 UniversalIdentifier ( CharPtr ) throw ( Assertion )
 Constructs from string.

 UniversalIdentifier ( UniqueIdRef )
 Constructs from structure.

 UniversalIdentifier ( UniqueIdPtr ) throw ( Assertion )
 Constructs from structure.

virtual ~UniversalIdentifier ( void )
 Virtual destructor.

UniversalIdentifierRef operator= ( UniversalIdentifierCref )
 copy operator from a UniqueIdPtr.

UniversalIdentifierRef operator= ( CharPtr ) throw ( Assertion )
 copy operator from a CharPtr.

UniversalIdentifierRef operator= ( UniqueIdRef )
 copy operator from a UniqueIdPtr.

UniversalIdentifierRef operator= ( UniqueIdPtr ) throw ( Assertion )
 copy operator from a UniqueIdPtr.

bool isZero ( void ) const
 Compares this instance to theZeorUid. More...

bool isDeleted ( void ) const
 Compares this instance to theDeletedUid. More...

void getAsString ( CharPtr ) const
 Retrieves the instance as a string. More...

UniqueIdCref getUniqueId ( void ) const
 Retrieves the instance structure. More...


Static Public Methods

UniversalIdentifierCref getZeroUid ( void )
 Fetch theZeroUid.

UniversalIdentifierCref getDeletedUid ( void )
 Fetch theDeletedUid.

void setNewUid ( UniversalIdentifierRef )
 set a new unique Id. More...


Protected Methods

virtual bool isGreaterThan (IdentifierCref) const
 Greater than method. More...

virtual bool isLessThan (IdentifierCref) const
 Less than method. More...

virtual bool isLessThanOrEqual (IdentifierCref) const
 Less than or equal method. More...

virtual bool isGreaterThanOrEqual (IdentifierCref) const
 Greater than or equal method. More...

virtual bool isEqual (IdentifierCref) const
 Equality method. More...


Protected Attributes

UniqueId theID
 the UniqueId.

Detailed Description

universal unique identifier type

Constructor & Destructor Documentation

corelinux::UniversalIdentifier::UniversalIdentifier ( void )
 

Default constructor.

corelinux::UniversalIdentifier::UniversalIdentifier ( UniversalIdentifierCref aUiRef )
 

Constructs from structure.

corelinux::UniversalIdentifier::UniversalIdentifier ( CharPtr aCharUid ) throw ( Assertion )
 

Constructs from string.

corelinux::UniversalIdentifier::UniversalIdentifier ( UniqueIdRef aUid )
 

Constructs from structure.

corelinux::UniversalIdentifier::UniversalIdentifier ( UniqueIdPtr aUidPtr ) throw ( Assertion )
 

Constructs from structure.

corelinux::UniversalIdentifier::~UniversalIdentifier ( void ) [virtual]
 

Virtual destructor.

Member Function Documentation

void corelinux::UniversalIdentifier::getAsString ( CharPtr aPtr ) const
 

Retrieves the instance as a string.

Parameters:
Char   pointer to delivery buffer
Exceptions:
NullPointerException   if pointer invalid

UniversalIdentifierCref corelinux::UniversalIdentifier::getDeletedUid ( void ) [static]
 

Fetch theDeletedUid.

UniqueIdCref corelinux::UniversalIdentifier::getUniqueId ( void ) const
 

Retrieves the instance structure.

Returns:
UniqueId const reference

UniversalIdentifierCref corelinux::UniversalIdentifier::getZeroUid ( void ) [static]
 

Fetch theZeroUid.

bool corelinux::UniversalIdentifier::isDeleted ( void ) const
 

Compares this instance to theDeletedUid.

Returns:
bool true if deleted, false otherwise

bool corelinux::UniversalIdentifier::isEqual ( IdentifierCref aIdRef ) const [protected, virtual]
 

Equality method.

Parameters:
Identifier   const reference
Returns:
true if equal, false otherwise

bool corelinux::UniversalIdentifier::isGreaterThan ( IdentifierCref aIdRef ) const [protected, virtual]
 

Greater than method.

Parameters:
Identifier   const reference
Returns:
true if greater than, false otherwise

bool corelinux::UniversalIdentifier::isGreaterThanOrEqual ( IdentifierCref aIdRef ) const [protected, virtual]
 

Greater than or equal method.

Parameters:
Identifier   const reference
Returns:
true if greater than or equal, false otherwise

bool corelinux::UniversalIdentifier::isLessThan ( IdentifierCref aIdRef ) const [protected, virtual]
 

Less than method.

Parameters:
Identifier   const reference
Returns:
true if less than, false otherwise

bool corelinux::UniversalIdentifier::isLessThanOrEqual ( IdentifierCref aIdRef ) const [protected, virtual]
 

Less than or equal method.

Parameters:
Identifier   const reference
Returns:
true if less than or equal, false otherwise

bool corelinux::UniversalIdentifier::isZero ( void ) const
 

Compares this instance to theZeorUid.

Returns:
bool true if zero, false otherwise

UniversalIdentifierRef corelinux::UniversalIdentifier::operator= ( UniqueIdPtr aUidPtr ) throw ( Assertion )
 

copy operator from a UniqueIdPtr.

UniversalIdentifierRef corelinux::UniversalIdentifier::operator= ( UniqueIdRef aUidRef )
 

copy operator from a UniqueIdPtr.

UniversalIdentifierRef corelinux::UniversalIdentifier::operator= ( CharPtr aCharUid ) throw ( Assertion )
 

copy operator from a CharPtr.

UniversalIdentifierRef corelinux::UniversalIdentifier::operator= ( UniversalIdentifierCref aUiRef )
 

copy operator from a UniqueIdPtr.

void corelinux::UniversalIdentifier::setNewUid ( UniversalIdentifierRef aUiRef ) [static]
 

set a new unique Id.

Parameters:
UniversalIdentifierRef  

Member Data Documentation

UniqueId corelinux::UniversalIdentifier::theID [protected]
 

the UniqueId.

The documentation for this class was generated from the following files:
This is the CoreLinux++ Framework reference manual
Provided by The CoreLinux Consortium