DWFCore::DWFUUIDImpl_ANSI Interface Reference

#include "dwfcore/ansi/UUID.h"

Inheritance diagram for DWFCore::DWFUUIDImpl_ANSI:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

Implementation class for generating uuids on all platforms.

Since:
1.0.1
If available, libuuid will be used to generate these values; otherwise, a generic algorithm will be used.

Note:
This object is created internally by DWFUUID.

Definition at line 60 of file ansi/UUID.h.

Public Member Functions

 DWFUUIDImpl_ANSI () throw ()
 DWFUUIDImpl_ANSI (const DWFUUIDImpl_ANSI &rUUID) throw ()
virtual ~DWFUUIDImpl_ANSI () throw ()
DWFUUIDImpl_ANSIoperator= (const DWFUUIDImpl_ANSI &rUUID) throw ()
DWFUUIDImplclone () const throw ( DWFException )
const DWFStringuuid (bool bSquash) throw ( DWFException )
const DWFStringnext (bool bSquash) throw ( DWFException )


Constructor & Destructor Documentation

DWFCore::DWFUUIDImpl_ANSI::DWFUUIDImpl_ANSI  )  throw ()
 

Constructor

Exceptions:
None 

DWFCore::DWFUUIDImpl_ANSI::DWFUUIDImpl_ANSI const DWFUUIDImpl_ANSI rUUID  )  throw ()
 

Copy Constructor

Parameters:
rUUID The source from which to copy the uuid value.
Exceptions:
None 

virtual DWFCore::DWFUUIDImpl_ANSI::~DWFUUIDImpl_ANSI  )  throw () [virtual]
 

Destructor

Exceptions:
None 


Member Function Documentation

DWFUUIDImpl* DWFCore::DWFUUIDImpl_ANSI::clone  )  const throw ( DWFException ) [virtual]
 

Create a copy of the generator object.

Returns:
A pointer to a new object. This pointer must be deleted with the DWFCORE_FREE_OBJECT macro.
Exceptions:
DWFException 

Implements DWFCore::DWFUUIDImpl.

const DWFString& DWFCore::DWFUUIDImpl_ANSI::next bool  bSquash  )  throw ( DWFException ) [virtual]
 

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 

Implements DWFCore::DWFUUIDImpl.

DWFUUIDImpl_ANSI& DWFCore::DWFUUIDImpl_ANSI::operator= const DWFUUIDImpl_ANSI rUUID  )  throw ()
 

Assignment Operator

Parameters:
rUUID The source from which to copy the uuid value.
Exceptions:
None 

const DWFString& DWFCore::DWFUUIDImpl_ANSI::uuid bool  bSquash  )  throw ( DWFException ) [virtual]
 

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 

Implements DWFCore::DWFUUIDImpl.


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