Stores a UUID (Universally Unique Identifier). More...

#include <plUuid.h>

Public Member Functions
	plUuid ()
	plUuid (unsigned int data1, unsigned short data2, unsigned short data3, const unsigned char *data4)
	plUuid (const char *str)
plUuid &	operator= (const plUuid &init)
bool	operator== (const plUuid &other) const
bool	operator!= (const plUuid &other) const
void	read (hsStream *S)
void	read (const unsigned char *buffer)
void	write (hsStream *S)
void	write (unsigned char *buffer) const
void	prcWrite (pfPrcHelper *prc)
void	prcParse (const pfPrcTag *tag)
void	clear ()
bool	isNull () const
plString	toString () const
void	fromString (const plString &str)

Detailed Description

Stores a UUID (Universally Unique Identifier).

Constructor & Destructor Documentation

plUuid::plUuid ( )

Constructs a null UUID, i.e. 00000000-0000-0000-0000-000000000000.

Constructs a UUID from the four arguments. The argument data4 should be a pointer to an unsigned char array with 8 elements.

plUuid::plUuid ( const char * str )

Constructs a UUID from a string in the form of "00000000-0000-0000-0000-000000000000".

void plUuid::clear ( )

Sets the UUID to 00000000-0000-0000-0000-000000000000.

void plUuid::fromString ( const plString & str )

Parses the UUID from a plString representation in the form of "00000000-0000-0000-0000-000000000000".

Exceptions

hsBadParamException given string doesn't appear to be a valid UUID string representation

bool plUuid::isNull ( ) const

Returns true if the UUID is 00000000-0000-0000-0000-000000000000.

bool plUuid::operator!= ( const plUuid & other ) const

Returns true if the two UUIDs are non-identical.

plUuid& plUuid::operator= ( const plUuid & init )

Copies the UUID data from init to this UUID object.

bool plUuid::operator== ( const plUuid & other ) const

Returns true if the two UUIDs are identical.

void plUuid::prcParse ( const pfPrcTag * tag )

Parses the UUID from PRC source.

void plUuid::prcWrite ( pfPrcHelper * prc )

Writes the UUID to PRC source.

void plUuid::read ( hsStream * S )

Read the UUID from a stream

void plUuid::read ( const unsigned char * buffer )

Reads the UUID from a buffer.

plString plUuid::toString ( ) const

Returns a string representation of this UUID in the form of "00000000-0000-0000-0000-000000000000" as a plString.

void plUuid::write ( hsStream * S )

Writes the UUID to a stream

void plUuid::write ( unsigned char * buffer ) const

Writes the UUID to a buffer.

The documentation for this struct was generated from the following file: