Qt 4.8
|
The QUuid class stores a Universally Unique Identifier (UUID). More...
#include <quuid.h>
Public Types | |
enum | Variant { VarUnknown =-1, NCS = 0, DCE = 2, Microsoft = 6, Reserved = 7 } |
This enum defines the values used in the Variant field {variant field} of the UUID. More... | |
enum | Version { VerUnknown =-1, Time = 1, EmbeddedPOSIX = 2, Name = 3, Random = 4 } |
This enum defines the values used in the Version field {version field} of the UUID. More... | |
Public Functions | |
bool | isNull () const |
Returns true if this is the null UUID {00000000-0000-0000-0000-000000000000}; otherwise returns false. More... | |
operator GUID () const | |
Returns a Windows GUID from a QUuid. More... | |
operator QString () const | |
Returns the string representation of the uuid. More... | |
bool | operator!= (const QUuid &orig) const |
Returns true if this QUuid and the other QUuid are different; otherwise returns false. More... | |
bool | operator!= (const GUID &guid) const |
Returns true if this UUID is not equal to the Windows GUID guid; otherwise returns false. More... | |
bool | operator< (const QUuid &other) const |
Returns true if this QUuid has the same Variant field {variant field} as the other QUuid and is lexicographically before the other QUuid. More... | |
QUuid & | operator= (const GUID &guid) |
Assigns a Windows guid to a Qt QUuid. More... | |
bool | operator== (const QUuid &orig) const |
Returns true if this QUuid and the other QUuid are identical; otherwise returns false. More... | |
bool | operator== (const GUID &guid) const |
Returns true if this UUID is equal to the Windows GUID guid; otherwise returns false. More... | |
bool | operator> (const QUuid &other) const |
Returns true if this QUuid has the same Variant field {variant field} as the other QUuid and is lexicographically after the other QUuid. More... | |
QUuid () | |
Creates the null UUID. More... | |
QUuid (uint l, ushort w1, ushort w2, uchar b1, uchar b2, uchar b3, uchar b4, uchar b5, uchar b6, uchar b7, uchar b8) | |
Creates a UUID with the value specified by the parameters, l, w1, w2, b1, b2, b3, b4, b5, b6, b7, b8. More... | |
QUuid (const QString &) | |
Creates a QUuid object from the string text, which must be formatted as five hex fields separated by '-', e.g., "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}" where 'x' is a hex digit. More... | |
QUuid (const char *) | |
QUuid (const QByteArray &) | |
Creates a QUuid object from the QByteArray text, which must be formatted as five hex fields separated by '-', e.g., "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}" where 'x' is a hex digit. More... | |
QUuid (const GUID &guid) | |
Casts a Windows guid to a Qt QUuid. More... | |
QByteArray | toByteArray () const |
Returns the binary representation of this QUuid. More... | |
QByteArray | toRfc4122 () const |
Returns the binary representation of this QUuid. More... | |
QString | toString () const |
Returns the string representation of this QUuid. More... | |
QUuid::Variant | variant () const |
Returns the value in the Variant field {variant field} of the UUID. More... | |
QUuid::Version | version () const |
Returns the Version field {version field} of the UUID, if the UUID's Variant field {variant field} is QUuid::DCE. More... | |
Static Public Functions | |
static QUuid | createUuid () |
On any platform other than Windows, this function returns a new UUID with variant QUuid::DCE and version QUuid::Random. More... | |
static QUuid | fromRfc4122 (const QByteArray &) |
Creates a QUuid object from the binary representation of the UUID given by bytes, as specified by RFC 4122 section 4. More... | |
Public Variables | |
uint | data1 |
ushort | data2 |
ushort | data3 |
uchar | data4 [8] |
Related Functions | |
(Note that these are not member functions.) | |
QDataStream & | operator<< (QDataStream &s, const QUuid &id) |
Writes the UUID id to the data stream s. More... | |
QDataStream & | operator>> (QDataStream &s, QUuid &id) |
Reads a UUID from the stream s into id. More... | |
The QUuid class stores a Universally Unique Identifier (UUID).
Using Universally Unique IDentifiers (UUID) is a standard way to uniquely identify entities in a distributed computing environment. A UUID is a 16-byte (128-bit) number generated by some algorithm that is meant to guarantee that the UUID will be unique in the distributed computing environment where it is used. The acronym GUID is often used instead, Globally Unique IDentifiers, but it refers to the same thing.
Actually, the GUID is one variant of UUID. Multiple variants are in use. Each UUID contains a bit field that specifies which type (variant) of UUID it is. Call variant() to discover which type of UUID an instance of QUuid contains. It extracts the three most signifcant bits of byte 8 of the 16 bytes. In QUuid, byte 8 is QUuid::data4[0]
. If you create instances of QUuid using the constructor that accepts all the numeric values as parameters, use the following table to set the three most significant bits of parameter b1
, which becomes QUuid::data4[0]
and contains the variant field in its three most significant bits. In the table, 'x' means {don't care}.
msb0 | msb1 | msb2 | Variant |
0 | x | x | NCS (Network Computing System) |
1 | 0 | x | DCE (Distributed Computing Environment) |
1 | 1 | 0 | Microsoft (GUID) |
1 | 1 | 1 | Reserved for future expansion |
If variant() returns QUuid::DCE, the UUID also contains a version field in the four most significant bits of QUuid::data3
, and you can call version() to discover which version your QUuid contains. If you create instances of QUuid using the constructor that accepts all the numeric values as parameters, use the following table to set the four most significant bits of parameter w2
, which becomes QUuid::data3
and contains the version field in its four most significant bits.
msb0 | msb1 | msb2 | msb3 | Version |
0 | 0 | 0 | 1 | Time |
0 | 0 | 1 | 0 | Embedded POSIX |
0 | 0 | 1 | 1 | Name |
0 | 1 | 0 | 0 | Random |
The field layouts for the DCE versions listed in the table above are specified in the Network Working Group UUID Specification.
Most platforms provide a tool for generating new UUIDs, e.g. uuidgen
and guidgen
. You can also use createUuid(). UUIDs generated by createUuid() are of the random type. Their QUuid::Version bits are set to QUuid::Random, and their QUuid::Variant bits are set to QUuid::DCE. The rest of the UUID is composed of random numbers. Theoretically, this means there is a small chance that a UUID generated by createUuid() will not be unique. But it is a very small chance.
UUIDs can be constructed from numeric values or from strings, or using the static createUuid() function. They can be converted to a string with toString(). UUIDs have a variant() and a version(), and null UUIDs return true from isNull().
enum QUuid::Variant |
This enum defines the values used in the Variant field {variant field} of the UUID.
The value in the variant field determines the layout of the 128-bit value.
Enumerator | |
---|---|
VarUnknown | |
NCS | |
DCE | |
Microsoft | |
Reserved |
Definition at line 69 of file quuid.h.
enum QUuid::Version |
This enum defines the values used in the Version field {version field} of the UUID.
The version field is meaningful only if the value in the Variant field {variant field} is QUuid::DCE.
Enumerator | |
---|---|
VerUnknown | |
Time | |
EmbeddedPOSIX | |
Name | |
Random |
Definition at line 77 of file quuid.h.
|
inline |
Creates the null UUID.
toString() will output the null UUID as "{00000000-0000-0000-0000-000000000000}".
Definition at line 85 of file quuid.h.
Referenced by fromRfc4122(), and QUuid().
|
inline |
QUuid::QUuid | ( | const QString & | text | ) |
Creates a QUuid object from the string text, which must be formatted as five hex fields separated by '-', e.g., "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}" where 'x' is a hex digit.
The curly braces shown here are optional, but it is normal to include them. If the conversion fails, a null UUID is created. See toString() for an explanation of how the five hex fields map to the public data members in QUuid.
Definition at line 335 of file quuid.cpp.
QUuid::QUuid | ( | const char * | text | ) |
Definition at line 358 of file quuid.cpp.
QUuid::QUuid | ( | const QByteArray & | text | ) |
Creates a QUuid object from the QByteArray text, which must be formatted as five hex fields separated by '-', e.g., "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}" where 'x' is a hex digit.
The curly braces shown here are optional, but it is normal to include them. If the conversion fails, a null UUID is created. See toByteArray() for an explanation of how the five hex fields map to the public data members in QUuid.
Definition at line 384 of file quuid.cpp.
|
inline |
|
static |
On any platform other than Windows, this function returns a new UUID with variant QUuid::DCE and version QUuid::Random.
If the /dev/urandom device exists, then the numbers used to construct the UUID will be of cryptographic quality, which will make the UUID unique. Otherwise, the numbers of the UUID will be obtained from the local pseudo-random number generator (qrand(), which is seeded by qsrand()) which is usually not of cryptograhic quality, which means that the UUID can't be guaranteed to be unique.
On a Windows platform, a GUID is generated, which almost certainly will be unique, on this or any other system, networked or not.
Definition at line 897 of file quuid.cpp.
Referenced by QBBRootWindow::createWindowGroup(), QFontEngineFTRawFont::initFromData(), QMainWindowLayout::insertIntoMacToolbar(), operator>(), QAuBucketQWS::QAuBucketQWS(), QNetworkSessionPrivateImpl::QNetworkSessionPrivateImpl(), and QMacPrintEnginePrivate::setPaperSize().
|
static |
Creates a QUuid object from the binary representation of the UUID given by bytes, as specified by RFC 4122 section 4.
1.2. See toRfc4122() for a further explanation of the order of bytes required.
The byte array accepted is not a human readable format.
If the conversion fails, a null UUID is created.
Definition at line 421 of file quuid.cpp.
Referenced by operator>>().
bool QUuid::isNull | ( | ) | const |
Returns true if this is the null UUID {00000000-0000-0000-0000-000000000000}; otherwise returns false.
Definition at line 700 of file quuid.cpp.
Referenced by classIDL(), QAxServerBase::internalConnect(), QAxBase::queryInterface(), MetaObjectGenerator::readEnumInfo(), QAxBase::setControl(), variant(), and version().
|
inline |
|
inline |
Returns the string representation of the uuid.
Definition at line 111 of file quuid.h.
|
inline |
|
inline |
bool QUuid::operator< | ( | const QUuid & | other | ) | const |
Returns true if this QUuid has the same Variant field {variant field} as the other QUuid and is lexicographically before the other QUuid.
If the other QUuid has a different variant field, the return value is determined by comparing the two variants.
Definition at line 807 of file quuid.cpp.
|
inline |
|
inline |
bool QUuid::operator> | ( | const QUuid & | other | ) | const |
Returns true if this QUuid has the same Variant field {variant field} as the other QUuid and is lexicographically after the other QUuid.
If the other QUuid has a different variant field, the return value is determined by comparing the two variants.
Definition at line 836 of file quuid.cpp.
QByteArray QUuid::toByteArray | ( | ) | const |
Returns the binary representation of this QUuid.
The byte array is formatted as five hex fields separated by '-' and enclosed in curly braces, i.e., "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}" where 'x' is a hex digit. From left to right, the five hex fields are obtained from the four public data members in QUuid as follows:
Field # | Source |
1 | data1 |
2 | data2 |
3 | data3 |
4 | data4[0] .. data4[1] |
5 | data4[2] .. data4[7] |
Definition at line 558 of file quuid.cpp.
Referenced by QFontEngineFTRawFont::initFromData().
QByteArray QUuid::toRfc4122 | ( | ) | const |
Returns the binary representation of this QUuid.
The byte array is in big endian format, and formatted according to RFC 4122, section 4.1.2 - "Layout and byte order".
The order is as follows:
Field # | Source |
1 | data1 |
2 | data2 |
3 | data3 |
4 | data4[0] .. data4[7] |
Definition at line 601 of file quuid.cpp.
QString QUuid::toString | ( | ) | const |
Returns the string representation of this QUuid.
The string is formatted as five hex fields separated by '-' and enclosed in curly braces, i.e., "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}" where 'x' is a hex digit. From left to right, the five hex fields are obtained from the four public data members in QUuid as follows:
Field # | Source |
1 | data1 |
2 | data2 |
3 | data3 |
4 | data4[0] .. data4[1] |
5 | data4[2] .. data4[7] |
Definition at line 512 of file quuid.cpp.
Referenced by classIDL(), QBBRootWindow::createWindowGroup(), DumpIDL(), MetaObjectGenerator::readClassInfo(), MetaObjectGenerator::readEventInfo(), MetaObjectGenerator::readInterfaceInfo(), QAxBase::setControl(), and UpdateRegistry().
QUuid::Variant QUuid::variant | ( | ) | const |
Returns the value in the Variant field {variant field} of the UUID.
If the return value is QUuid::DCE, call version() to see which layout it uses. The null UUID is considered to be of an unknown variant.
Definition at line 756 of file quuid.cpp.
Referenced by operator<(), operator>(), and version().
QUuid::Version QUuid::version | ( | ) | const |
Returns the Version field {version field} of the UUID, if the UUID's Variant field {variant field} is QUuid::DCE.
Otherwise it returns QUuid::VerUnknown.
Definition at line 780 of file quuid.cpp.
|
related |
Writes the UUID id to the data stream s.
Definition at line 630 of file quuid.cpp.
|
related |
Reads a UUID from the stream s into id.
Definition at line 666 of file quuid.cpp.
uint QUuid::data1 |
Definition at line 179 of file quuid.h.
Referenced by createUuid(), isNull(), operator<(), operator<<(), operator==(), operator>(), QUuid(), toByteArray(), toRfc4122(), and toString().
ushort QUuid::data2 |
Definition at line 180 of file quuid.h.
Referenced by isNull(), operator<(), operator<<(), operator==(), operator>(), QUuid(), toByteArray(), toRfc4122(), and toString().
ushort QUuid::data3 |
Definition at line 181 of file quuid.h.
Referenced by createUuid(), isNull(), operator<(), operator<<(), operator==(), operator>(), QUuid(), toByteArray(), toRfc4122(), toString(), and version().
uchar QUuid::data4[8] |
Definition at line 182 of file quuid.h.
Referenced by createUuid(), isNull(), operator<(), operator<<(), operator==(), operator>(), QUuid(), toByteArray(), toRfc4122(), toString(), and variant().