Kaim::GeneratorGuidCompound Class Reference

#include <generatorguidcompound.h>

Class Description

This class is a wrapper around an array of KyGuid objects.

Public Member Functions
	GeneratorGuidCompound ()
	GeneratorGuidCompound (const GuidCompound &guidCompound)
void	AddGuid (const KyGuid &guid)
bool	AreGuidsEqual (const GeneratorGuidCompound &other) const
bool	DoesContain (const KyGuid &guid) const
KyGuid	GetMainGuid () const
void	InitFromBlob (const GuidCompound &guidCompound)
bool	operator< (const GeneratorGuidCompound &other) const
bool	operator== (const GeneratorGuidCompound &other) const
void	SetTimeStamp (KyUInt32 timeStamp)
void	Sort ()

Public Attributes
KyArray< KyGuid >	m_guids
KyUInt32	m_timeStamp

Constructor & Destructor Documentation

Kaim::GeneratorGuidCompound::GeneratorGuidCompound ( )

inline

Constructs a new GeneratorGuidCompound with an empty KyGuid array.

Kaim::GeneratorGuidCompound::GeneratorGuidCompound ( const GuidCompound &  guidCompound )

inline

Constructs GeneratorGuidCompound from guidCompound.

Member Function Documentation

void Kaim::GeneratorGuidCompound::AddGuid

(

const KyGuid &

guid

)

Adds the specified KyGuid to the array maintained by this object.

bool Kaim::GeneratorGuidCompound::AreGuidsEqual

(

const GeneratorGuidCompound &

other

)

const

Returns

true if all GUIDs in the array maintained by this object match the GUIDs in the specified GeneratorGuidCompound.

bool Kaim::GeneratorGuidCompound::DoesContain

(

const KyGuid &

guid

)

const

Returns

true if the specified KyGuid is in the array maintained by this object.

KyGuid Kaim::GeneratorGuidCompound::GetMainGuid ( ) const

inline

Returns

The first KyGuid in the array, or KyGuid::GetDefaultGuid() if none.

void Kaim::GeneratorGuidCompound::InitFromBlob

(

const GuidCompound &

guidCompound

)

Initialize from guidCompound (blob)

bool Kaim::GeneratorGuidCompound::operator<

(

const GeneratorGuidCompound &

other

)

const

Returns

true if this object has more KyGuid objects in its array than the specified GeneratorGuidCompound, or false if it has fewer.

If they have the same number of KyGuid objects, iterates through each KyGuid in the arrays. For internal use. Note that this operator compare also the timeStamps so that we do the same as in GuidCompound but, this is useless since all the GeneratorGuidCompound have the same timeStamp during the generation

bool Kaim::GeneratorGuidCompound::operator== ( const GeneratorGuidCompound &  other ) const

inline

Note that this operator compare also the timeStamps so that we do the same as in GuidCompound but, this is useless since all the GeneratorGuidCompound have the same timeStamp during the generation.

void Kaim::GeneratorGuidCompound::SetTimeStamp ( KyUInt32  timeStamp )

inline

Sets the last modified timestamp for this object to the specified value. For internal use.

void Kaim::GeneratorGuidCompound::Sort

(

)

Sorts the KyGuid objects in the array. For internal use.

Member Data Documentation

KyArray<KyGuid> Kaim::GeneratorGuidCompound::m_guids

The array of KyGuid objects. Do not modify directly.

KyUInt32 Kaim::GeneratorGuidCompound::m_timeStamp

The last modification date of this object. Do not modify directly.

---

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

• gwnavgeneration/generator/generatorguidcompound.h