Unigine::UGUID Class
Header: | #include <UnigineGUID.h> |
This class represents a globally unique identifier (a 40-byte hash value). The SHA1 algorithm is used for hash generation.
UGUID Class
Members
static UGUIDPtr create()
Default constructor. Creates an empty 0-filled UGUID.static UGUIDPtr create(const char * str)
Constructor. Creates a UGUID from the given source string. UGUID is generated using the SHA1 algorithm.Arguments
- const char * str - Source string.
static UGUIDPtr create(const UGUID & guid)
Copy constructor. Creates a UGUID by copying a source UGUID.Arguments
- const UGUID & guid - Source UGUID.
void generate()
Generates a new random UGUID value.void generate(const char * str)
Generates a UGUID value from the given source string using the SHA1 algorithm.Arguments
- const char * str - Source string.
void clear()
Clears the UGUID value. All 40 bytes are set to 0.int isEmpty()
Returns a value indicating if the UGUID is empty (all 40 bytes are equal to 0).Return value
1 if the UGUID is empty; otherwise, 0.int isValid()
Returns a value indicating if the UGUID has a valid value.Return value
1 if the value is valid; otherwise, 0.const char * getFileSystemString()
Returns the string containing the UGUID value with the filesystem prefix "guid://".Return value
UGUID value with the filesystem prefix "guid://".void setString(const char * str)
Sets the UGUID value equal to a given 40-character hexadecimal string.Arguments
- const char * str - 40-character hexadecimal string representing the UGUID value.
const char * getString()
Returns the UGUID value as a 40-character hexadecimal string.Return value
40-character hexadecimal string representing the UGUID value.UGUID & operator=(const char * str)
Performs UGUID assignment. The value of the destination UGUID is set equal to the source hexadecimal string.Arguments
- const char * str - Source string. A 40-character hexadecimal string representing the UGUID value.
Return value
Result.UGUID & operator=(const UGUID & g)
Performs UGUID assignment. Destination UGUID = Source UGUID.Arguments
- const UGUID & g - Source UGUID.
Return value
Result.int operator>(const UGUID & g)
Indicates whether the UGUID value is greater than the source UGUID value.Arguments
- const UGUID & g - Source UGUID.
Return value
1 if the UGUID value is greater than the source UGUID value; otherwise, 0.int operator>=(const UGUID & g)
Indicates whether the UGUID value is greater than or equal to the source UGUID value.Arguments
- const UGUID & g - Source UGUID.
Return value
1 if the UGUID value is greater than or equal to the source UGUID value; otherwise, 0.int operator<(const UGUID & g)
Indicates whether the UGUID value is less than the source UGUID value.Arguments
- const UGUID & g - Source UGUID.
Return value
1 if the UGUID value is less than or equal to the source UGUID value; otherwise, 0.int operator<=(const UGUID & g)
Indicates whether the UGUID value is less than or equal to the source UGUID value.Arguments
- const UGUID & g - Source UGUID.
Return value
1 if the UGUID value is less than or equal to the source UGUID value; otherwise, 0.int operator==(const UGUID & g)
Equality. Indicates whether the UGUID value is equal to the source UGUID value.Arguments
- const UGUID & g - Source UGUID.
Return value
1 if the UGUID value is equal to the source UGUID value; otherwise, 0.int operator!=(const UGUID & g)
Inequality. Indicates whether the UGUID value is not equal to the source UGUID value.Arguments
- const UGUID & g - Source UGUID.
Return value
1 if the UGUID value is not equal to the source UGUID value; otherwise, 0.int empty
Description
Empty GUID, containing all 0s.Last update: 2018-06-04
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)