DWFCore::DWFUUID Class Reference

#include "dwfcore/UUID.h"

Inheritance diagram for DWFCore::DWFUUID:

Inheritance graph
[legend]
Collaboration diagram for DWFCore::DWFUUID:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class represents a 128-bit uuid value.

Since:
1.0.1
Examples:

UUID/UUID.cpp.

Definition at line 136 of file UUID.h.

Public Member Functions

_DWFCORE_API throw ()
_DWFCORE_API throw ()
_DWFCORE_API ~DWFUUID () throw ()
_DWFCORE_API DWFUUIDoperator= (const DWFUUID &rUUID) throw ()
_DWFCORE_API const DWFStringuuid (bool bSquash) throw ( DWFException )
_DWFCORE_API const DWFStringnext (bool bSquash) throw ( DWFException )
_DWFCORE_API DWFUUID next () throw ( DWFException )


Constructor & Destructor Documentation

_DWFCORE_API DWFCore::DWFUUID::~DWFUUID  )  throw ()
 

Destructor

Exceptions:
None 


Member Function Documentation

_DWFCORE_API DWFUUID DWFCore::DWFUUID::next  )  throw ( DWFException )
 

Generates a new uuid by incrementing the timestamp portion of the current value. This method allows for the creation of sequential uuids that are statistically only slightly less unique that the original.

Note:
This method does not alter the object. Instead it generates a new one.

The process will only increment the 32-bit timestamp portion of the 128-bit uuid. As a rule, once this value reaches the 0xffffffee limit, a brand new uuid value will be generated.

Returns:
A new object containing the next uuid in the sequence.
Exceptions:
DWFException 

_DWFCORE_API const DWFString& DWFCore::DWFUUID::next bool  bSquash  )  throw ( DWFException )
 

Modifies the uuid by incrementing the timestamp portion of the current value. This method allows for the creation of sequential uuids that are statistically only slightly less unique that the original.

Note:
The process will only increment the 32-bit timestamp portion of the 128-bit uuid. As a rule, once this value reaches the 0xffffffee limit, a brand new uuid value will be generated instead.
Parameters:
bSquash if true, the 128-bit uuid will be Base64 encoded into a short form string representation, otherwise the standard form string representation will be returned. The encoding used for the short form string will be non RFC 1521 compliant as detailed in DWFString::EncodeBase64().
Returns:
A string representation of the uuid.
Exceptions:
DWFException 
Examples:
UUID/UUID.cpp.

_DWFCORE_API DWFUUID& DWFCore::DWFUUID::operator= const DWFUUID rUUID  )  throw ()
 

Assignment Operator

Parameters:
rUUID Contains the uuid value to copy.
Exceptions:
None 

_DWFCORE_API DWFCore::DWFUUID::throw  ) 
 

Copy Constructor

Parameters:
rUUID Contains the uuid value to copy.
Exceptions:
None 

_DWFCORE_API DWFCore::DWFUUID::throw  ) 
 

Constructor

Exceptions:
None 

_DWFCORE_API const DWFString& DWFCore::DWFUUID::uuid bool  bSquash  )  throw ( DWFException )
 

Returns a string representation of the current uuid.

Parameters:
bSquash if true, the 128-bit uuid will be Base64 encoded into a short form string representation, otherwise the standard form string representation will be returned. The encoding used for the short form string will be non RFC 1521 compliant as detailed in DWFString::EncodeBase64().
Returns:
A string representation of the uuid.
Exceptions:
DWFException 


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:39:43 2009 for Autodesk DWF Core Library by  doxygen 1.4.5