TrueReality  v0.1.1912
Public Member Functions | Private Attributes | List of all members
trBase::implId Class Reference

An implementation class for GUID. More...

Public Member Functions

 implId (bool createNewId)
 Constructor. More...
 
 implId (const implId &toCopy)
 Makes a copy of the passed in Unique ID GUID. More...
 
 implId (const std::string &toCopy)
 Constructor. More...
 
const std::string ToString () const
 Convert this object into a string representation. More...
 
void FromString (const std::string &idString)
 Initializes this object from the given string. More...
 
bool IsNull () const
 Returns true if the GUID is equal to 00000000-0000-0000-0000-000000000000. More...
 
uint8_t * GetData ()
 Gets the internal data array that holds the GUID bits. More...
 
implId & operator= (const implId &id)
 Assignment operator. More...
 
implId & operator= (const implId *id)
 Assignment operator. More...
 
implId & operator= (const std::string &id)
 Assignment operator. More...
 
bool operator== (const implId &id) const
 Equality operator. More...
 
bool operator!= (const implId &id) const
 Inequality operator. More...
 
bool operator< (const implId &id) const
 Less-than comparison operator. More...
 
bool operator> (const implId &id) const
 Greater-than comparison operator. More...
 

Private Attributes

bID::uuids::uuid mGUID
 

Detailed Description

An implementation class for GUID.

Definition at line 42 of file UniqueId.cpp.

Constructor & Destructor Documentation

◆ implId() [1/3]

trBase::implId::implId ( bool  createNewId)
inlineexplicit

Constructor.

Parameters
createNewIdif true, generates a new id. If not, it sets the id to empty.

Definition at line 53 of file UniqueId.cpp.

References mGUID.

Referenced by trBase::UniqueId::UniqueId().

Here is the caller graph for this function:

◆ implId() [2/3]

trBase::implId::implId ( const implId &  toCopy)
inline

Makes a copy of the passed in Unique ID GUID.

Parameters
toCopyto copy.

Definition at line 70 of file UniqueId.cpp.

◆ implId() [3/3]

trBase::implId::implId ( const std::string &  toCopy)
inlineexplicit

Constructor.

Parameters
toCopyto copy.

Definition at line 82 of file UniqueId.cpp.

Member Function Documentation

◆ FromString()

void trBase::implId::FromString ( const std::string &  idString)
inline

Initializes this object from the given string.

Parameters
[in,out]idStringThe identifier string.

Definition at line 106 of file UniqueId.cpp.

References mGUID.

Referenced by trBase::UniqueId::FromString().

Here is the caller graph for this function:

◆ GetData()

uint8_t * trBase::implId::GetData ( )
inline

Gets the internal data array that holds the GUID bits.

Returns
Null if it fails, else the data.

Definition at line 130 of file UniqueId.cpp.

References mGUID.

Referenced by trBase::UniqueId::UniqueId().

Here is the caller graph for this function:

◆ IsNull()

bool trBase::implId::IsNull ( ) const
inline

Returns true if the GUID is equal to 00000000-0000-0000-0000-000000000000.

Returns
True if null, false if not.

Definition at line 118 of file UniqueId.cpp.

References mGUID.

Referenced by trBase::UniqueId::IsNull().

Here is the caller graph for this function:

◆ operator!=()

bool trBase::implId::operator!= ( const implId &  id) const
inline

Inequality operator.

Parameters
idThe identifier.
Returns
True if the parameters are not considered equivalent.

Definition at line 213 of file UniqueId.cpp.

References mGUID.

◆ operator<()

bool trBase::implId::operator< ( const implId &  id) const
inline

Less-than comparison operator.

Parameters
idThe identifier.
Returns
True if the first parameter is less than the second.

Definition at line 227 of file UniqueId.cpp.

References mGUID.

◆ operator=() [1/3]

implId & trBase::implId::operator= ( const implId &  id)
inline

Assignment operator.

Parameters
idThe identifier.
Returns
A shallow copy of this object.

Definition at line 144 of file UniqueId.cpp.

References mGUID.

◆ operator=() [2/3]

implId & trBase::implId::operator= ( const implId *  id)
inline

Assignment operator.

Parameters
idThe identifier.
Returns
A shallow copy of this object.

Definition at line 164 of file UniqueId.cpp.

References mGUID.

◆ operator=() [3/3]

implId & trBase::implId::operator= ( const std::string &  id)
inline

Assignment operator.

Parameters
idThe identifier.
Returns
A shallow copy of this object.

Definition at line 184 of file UniqueId.cpp.

References mGUID.

◆ operator==()

bool trBase::implId::operator== ( const implId &  id) const
inline

Equality operator.

Parameters
idThe identifier.
Returns
True if the parameters are considered equivalent.

Definition at line 199 of file UniqueId.cpp.

References mGUID.

◆ operator>()

bool trBase::implId::operator> ( const implId &  id) const
inline

Greater-than comparison operator.

Parameters
idThe identifier.
Returns
True if the first parameter is greater than to the second.

Definition at line 241 of file UniqueId.cpp.

References mGUID.

◆ ToString()

const std::string trBase::implId::ToString ( ) const
inline

Convert this object into a string representation.

Returns
A const std::string that represents this object.

Definition at line 94 of file UniqueId.cpp.

References mGUID.

Referenced by trBase::UniqueId::ToString().

Here is the caller graph for this function:

Member Data Documentation

◆ mGUID

bID::uuids::uuid trBase::implId::mGUID
private

Definition at line 247 of file UniqueId.cpp.

Referenced by FromString(), GetData(), implId(), IsNull(), operator!=(), operator<(), operator=(), operator==(), operator>(), and ToString().

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