Kaim::KyGuid Class Reference

#include <kyguid.h>

Class Description

The KyGuid class represents a globally unique ID.

It is used by the NavData generation framework to uniquely identify each sector treated by the Generator.

Examples:

Public Member Functions
	KyGuid ()
	Creates an invalid KyGuid. More...
	KyGuid (const char guidString[])
	Creates a KyGuid from guidString. More...
	KyGuid (const KyGuid &rhs)
	Creates a new KyGuid copying the specified KyGuid. More...
	KyGuid (KyUInt8 values[16])
	Creates a new KyGuid from the 16 provided KyUInt8 values. More...
	KyGuid (KyUInt16 values[8])
	Creates a new KyGuid from the 8 provided KyUInt16 values. More...
	KyGuid (KyUInt32 values[4])
	Creates a new KyGuid from the 4 provided KyUInt32 values. More...
	KyGuid (KyUInt64 values[2])
	Creates a new KyGuid from the 2 provided KyUInt64 values. More...
	KyGuid (void *src)
	Creates a new KyGuid, copying the memory from the src buffer to the newly constructed object. More...
bool	IsValid () const
	Indicates whether the specified KyGuid is valid. More...
void	ToString (char guidString[]) const
	Converts this GUID to a string. More...
void	InitFromString (const char guidString[])
	Initializes this GUID using the specified string. More...

Static Public Member Functions
static const KyGuid &	GetDefaultGuid ()
	Returns the default KyGuid value. More...
static const KyGuid &	GetInvalidGuid ()
	Returns the invalid KyGuid value. More...

Constructor & Destructor Documentation

Kaim::KyGuid::KyGuid

(

)

Creates an invalid KyGuid.

Kaim::KyGuid::KyGuid ( const char  guidString[] )

explicit

Creates a KyGuid from guidString.

Asserts when guidString is not valid (see IsValidGuidString()).

Parameters

guidString

An array of 37 characters that will make up the GUID.

Kaim::KyGuid::KyGuid ( const KyGuid &  rhs )

inline

Creates a new KyGuid copying the specified KyGuid.

Kaim::KyGuid::KyGuid ( KyUInt8  values[16] )

explicit

Creates a new KyGuid from the 16 provided KyUInt8 values.

Parameters

values

An array of 16 KyUInt8 objects that will make up the GUID.

Kaim::KyGuid::KyGuid ( KyUInt16  values[8] )

explicit

Creates a new KyGuid from the 8 provided KyUInt16 values.

Parameters

values

An array of 8 KyUInt16 objects that will make up the GUID.

Kaim::KyGuid::KyGuid ( KyUInt32  values[4] )

explicit

Creates a new KyGuid from the 4 provided KyUInt32 values.

Parameters

values

An array of 4 KyUInt32 objects that will make up the GUID.

Kaim::KyGuid::KyGuid ( KyUInt64  values[2] )

explicit

Creates a new KyGuid from the 2 provided KyUInt64 values.

Parameters

values

An array of 2 KyUInt64 objects that will make up the GUID.

Kaim::KyGuid::KyGuid ( void *  src )

explicit

Creates a new KyGuid, copying the memory from the src buffer to the newly constructed object.

Member Function Documentation

const KyGuid & Kaim::KyGuid::GetDefaultGuid ( )

static

Returns the default KyGuid value.

Examples:

const KyGuid & Kaim::KyGuid::GetInvalidGuid ( )

static

Returns the invalid KyGuid value.

void Kaim::KyGuid::InitFromString

(

const char

guidString[]

)

Initializes this GUID using the specified string.

bool Kaim::KyGuid::IsValid ( ) const

inline

Indicates whether the specified KyGuid is valid.

void Kaim::KyGuid::ToString

(

char

guidString[]

)

const

Converts this GUID to a string.

---

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

• gwnavruntime/base/kyguid.h
• gwnavruntime/base/kyguid.cpp