CP_UUID Class Reference

List of all members.

Public Member Functions
CFUUIDRef	GetCFUUIDRef () const
	Get a CoreFoundation object for the UUID.
	~CP_UUID ()
	Destructor.
Constructor/Destructor
Constructor.
	CP_UUID ()
	CP_UUID (const CP_UUID &inSrc)
	CP_UUID (const CP_UUIDBytes &inUUIDBytes)
	CP_UUID (const CP_String &inUUIDString)
Constructor/Destructor
Constructor.
	CP_UUID (CFUUIDRef inUUIDRef)
	Construct a UUID object from a CoreFoundation UUID object reference.
Getters
CP_UUIDBytes	GetUUIDBytes () const
	Get the raw bytes forming the UUID.
CP_String	GetString () const
	Get a string representation of the UUID.
comparison
Check for equality
bool	operator== (const CP_UUID &inRhs) const
bool	operator!= (const CP_UUID &inRhs) const
bool	operator< (const CP_UUID &inRhs) const
	Order relations (usefull when using UUIDs as key into a map, etc.).
bool	operator<= (const CP_UUID &inRhs) const
bool	operator> (const CP_UUID &inRhs) const
bool	operator>= (const CP_UUID &inRhs) const
Assignment
Assign a new value to this UUID.
CP_UUID &	operator= (const CP_UUID &inRhs)
CP_UUID &	operator= (const CP_UUIDBytes &inRhs)
Static Public Member Functions
static CP_UUID	Create ()
	Creates a unique ID.
Static Public Attributes
static const CP_UUID	null
	the 'null' UUID consisting of only zero bytes
Protected Member Functions
void	AssertCFUUIDRef () const
	Assert we have a CoreFoundation object for the UUID.
Protected Attributes
CP_UUIDBytes	fBytes
	the bytes that form the UUID
Private Attributes
CFUUIDRef	fUUIDRef
	the CoreFoundation object reference for this UUID

---

Constructor & Destructor Documentation

CP_UUID::CP_UUID (   )

CP_UUID::CP_UUID (  const CP_UUID &  inSrc  )

CP_UUID::CP_UUID (  const CP_UUIDBytes &  inUUIDBytes  )

CP_UUID::CP_UUID (  const CP_String &  inUUIDString  )

CP_UUID::CP_UUID (  CFUUIDRef  inUUIDRef  )

Creates a CP_UUID object from a CoreFoundation UUID reference. Retains the CF reference as needed. Exceptions: none  Parameters: inUUIDRef  A CoreFoundation UUID reference representing the UUID.

CP_UUID::~CP_UUID (   )

---

Member Function Documentation

CFUUIDRef CP_UUID::GetCFUUIDRef (   )  const

Returns a reference to a CoreFoundation UUID object for this ID. This object is owned by CP_UUID, so you need to retain it if you want to hold onto it. Exceptions: CP_OSErrorException(coreFoundationUnknownErr)  raised if CoreFoundation object can't be allocated. Returns: inUUIDRef A CoreFoundation UUID reference representing the UUID.

CP_UUID CP_UUID::Create (   )  [static]

Creates a new, unique UUID. Exceptions: CP_OSErrorException(coreFoundationUnknownErr)  raised if CFUUID object can't be created (Mac). Returns: CP_UUID The new, unique UUID.

CP_UUIDBytes CP_UUID::GetUUIDBytes (   )  const

Copy the raw bytes that form the UUID. Useful to pass to functions that expect the raw bytes or e.g. when storing UUIDs. Exceptions: none  Returns: CP_UUIDBytes The raw bytes forming this UUID.

CP_String CP_UUID::GetString (   )  const

Constructs a string representation for the UUID in the standard format (e.g. "A6B41150-63E8-11D9-99B7-000393D77230") Exceptions: exceptions  raised by CP_String Returns: CP_String The string representation of the UUID.

bool CP_UUID::operator== (  const CP_UUID &  inRhs  )  const

bool CP_UUID::operator!= (  const CP_UUID &  inRhs  )  const

bool CP_UUID::operator< (  const CP_UUID &  inRhs  )  const

Note: Order relations are consistent during runtime, but not necessarily between platforms.

bool CP_UUID::operator<= (  const CP_UUID &  inRhs  )  const

bool CP_UUID::operator> (  const CP_UUID &  inRhs  )  const

bool CP_UUID::operator>= (  const CP_UUID &  inRhs  )  const

CP_UUID & CP_UUID::operator= (  const CP_UUID &  inRhs  )

CP_UUID & CP_UUID::operator= (  const CP_UUIDBytes &  inRhs  )

void CP_UUID::AssertCFUUIDRef (   )  const [protected]

Exceptions: CP_OSErrorException(coreFoundationUnknownErr)  raised if CoreFoundation object can't be allocated.

---

Member Data Documentation

const CP_UUID CP_UUID::null [static]

CP_UUIDBytes CP_UUID::fBytes [protected]

CFUUIDRef CP_UUID::fUUIDRef [mutable, private]

---

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

• CP_UUID.h
• CP_UUID.cpp

---