This is the documentation for Enlighten.
class Geo GeoGuid
class Geo::GeoGuid
A 128 bit identifier used to uniquely identify objects in the precompute.
Functions
| Name | Description |
|---|---|
| A() | Accessors to individual 32-bit components, corresponding to the args passed to Create. |
| B() | Accessors to individual 32-bit components, corresponding to the args passed to Create. |
| C() | Accessors to individual 32-bit components, corresponding to the args passed to Create. |
| Create(u64, u64) | Create a Guid from 2 u64 values. |
| Create(u32, u32, u64) | Create a Guid from 2 u32 values and 1 u64 value. |
| Create(u32, u32, u32, u32) | Create a Guid from 4 u32 values. |
| CreateFromHighFreqSystemClock(u64) | Creates a Guid from the high frequency system clock - this will be unique for this application instantiation. |
| D() | Accessors to individual 32-bit components, corresponding to the args passed to Create. |
| FromHexString(const GeoGuidString &) | Create a Guid from the incoming string (requires same text formatting as ToHexString) |
| FromHexString(const char *) | Create a Guid from the incoming string (requires same text formatting as ToHexString) |
| GeoGuid() | Constructor. |
| High() | Returns the 1st 64 bit block. |
| Low() | Returns the 2nd 64 bit block. |
| operator!=(const GeoGuid &) | Value comparison operators. |
| operator<(const GeoGuid &) | Value comparison operators. |
| operator<=(const GeoGuid &) | Value comparison operators. |
| operator==(const GeoGuid &) | Value comparison operators. |
| Random() | Create a GUID from whatever Random generator is provided in this system (CoCreateGuid, etc). |
| To32String() | Returns only the lowest 32 bits as decimal string. |
| ToHexString() | Returns full 128 bit value in hex. |
Variables
| Name | Description |
|---|---|
| const GeoGuid Invalid | A Guid that is always invalid. |
u32 Geo::GeoGuid::A
public: u32 A() const
Accessors to individual 32-bit components, corresponding to the args passed to Create.
u32 Geo::GeoGuid::B
public: u32 B() const
Accessors to individual 32-bit components, corresponding to the args passed to Create.
u32 Geo::GeoGuid::C
public: u32 C() const
Accessors to individual 32-bit components, corresponding to the args passed to Create.
GeoGuid Geo::GeoGuid::Create
public: GeoGuid Create
(
u64 a,
u64 b
)
Create a Guid from 2 u64 values.
GeoGuid Geo::GeoGuid::Create
public: GeoGuid Create
(
u32 idA,
u32 idB,
u64 idC
)
Create a Guid from 2 u32 values and 1 u64 value.
GeoGuid Geo::GeoGuid::Create
public: GeoGuid Create
(
u32 idA,
u32 idB,
u32 idC,
u32 idD
)
Create a Guid from 4 u32 values.
GeoGuid Geo::GeoGuid::CreateFromHighFreqSystemClock
public: GeoGuid CreateFromHighFreqSystemClock
(
u64 type
)
Creates a Guid from the high frequency system clock - this will be unique for this application instantiation.
u32 Geo::GeoGuid::D
public: u32 D() const
Accessors to individual 32-bit components, corresponding to the args passed to Create.
static GeoGuid Geo::GeoGuid::FromHexString
public: GeoGuid FromHexString
(
const GeoGuidString & fromString
)
Create a Guid from the incoming string (requires same text formatting as ToHexString)
static GeoGuid Geo::GeoGuid::FromHexString
public: GeoGuid FromHexString
(
const char * fromString
)
Create a Guid from the incoming string (requires same text formatting as ToHexString)
Geo::GeoGuid::GeoGuid
public: GeoGuid()
Constructor.
u64 Geo::GeoGuid::High
public: u64 High() const
Returns the 1st 64 bit block.
u64 Geo::GeoGuid::Low
public: u64 Low() const
Returns the 2nd 64 bit block.
bool Geo::GeoGuid::operator!=
public: bool operator!=
(
const GeoGuid & rhs
) const
Value comparison operators.
bool Geo::GeoGuid::operator<
public: bool operator<
(
const GeoGuid & rhs
) const
Value comparison operators.
bool Geo::GeoGuid::operator<=
public: bool operator<=
(
const GeoGuid & rhs
) const
Value comparison operators.
bool Geo::GeoGuid::operator==
public: bool operator==
(
const GeoGuid & rhs
) const
Value comparison operators.
static GeoGuid Geo::GeoGuid::Random
public: GeoGuid Random()
Create a GUID from whatever Random generator is provided in this system (CoCreateGuid, etc).
GeoGuidString Geo::GeoGuid::To32String
public: GeoGuidString To32String() const
Returns only the lowest 32 bits as decimal string.
GeoGuidString Geo::GeoGuid::ToHexString
public: GeoGuidString ToHexString() const
Returns full 128 bit value in hex.