Open CASCADE Technology  7.3.1.dev
Public Member Functions | Static Public Member Functions
Standard_GUID Class Reference

#include <Standard_GUID.hxx>

Public Member Functions

 Standard_GUID ()
 
 Standard_GUID (const Standard_CString aGuid)
 build a GUID from an ascii string with the following format: Length : 36 char "00000000-0000-0000-0000-000000000000" More...
 
 Standard_GUID (const Standard_ExtString aGuid)
 build a GUID from an unicode string with the following format: More...
 
 Standard_GUID (const Standard_Integer a32b, const Standard_ExtCharacter a16b1, const Standard_ExtCharacter a16b2, const Standard_ExtCharacter a16b3, const Standard_Byte a8b1, const Standard_Byte a8b2, const Standard_Byte a8b3, const Standard_Byte a8b4, const Standard_Byte a8b5, const Standard_Byte a8b6)
 
 Standard_GUID (const Standard_UUID &aGuid)
 
 Standard_GUID (const Standard_GUID &aGuid)
 
Standard_UUID ToUUID () const
 
void ToCString (const Standard_PCharacter aStrGuid) const
 translate the GUID into ascii string the aStrGuid is allocated by user. the guid have the following format: More...
 
void ToExtString (const Standard_PExtCharacter aStrGuid) const
 translate the GUID into unicode string the aStrGuid is allocated by user. the guid have the following format: More...
 
Standard_Boolean IsSame (const Standard_GUID &uid) const
 
Standard_Boolean operator== (const Standard_GUID &uid) const
 
Standard_Boolean IsNotSame (const Standard_GUID &uid) const
 
Standard_Boolean operator!= (const Standard_GUID &uid) const
 
void Assign (const Standard_GUID &uid)
 
void operator= (const Standard_GUID &uid)
 
void Assign (const Standard_UUID &uid)
 
void operator= (const Standard_UUID &uid)
 
void ShallowDump (Standard_OStream &aStream) const
 Display the GUID with the following format: More...
 
Standard_Integer Hash (const Standard_Integer Upper) const
 Hash function for GUID. More...
 

Static Public Member Functions

static Standard_Boolean CheckGUIDFormat (const Standard_CString aGuid)
 Check the format of a GUID string. It checks the size, the position of the '-' and the correct size of fields. More...
 
static Standard_Integer HashCode (const Standard_GUID &theGUID, Standard_Integer theUpperBound)
 Computes a hash code for the given GUID of the Standard_Integer type, in the range [1, theUpperBound]. More...
 
static Standard_Boolean IsEqual (const Standard_GUID &string1, const Standard_GUID &string2)
 Returns True when the two GUID are the same. More...
 

Constructor & Destructor Documentation

◆ Standard_GUID() [1/6]

Standard_GUID::Standard_GUID ( )

◆ Standard_GUID() [2/6]

Standard_GUID::Standard_GUID ( const Standard_CString  aGuid)

build a GUID from an ascii string with the following format: Length : 36 char "00000000-0000-0000-0000-000000000000"

◆ Standard_GUID() [3/6]

Standard_GUID::Standard_GUID ( const Standard_ExtString  aGuid)

build a GUID from an unicode string with the following format:

"00000000-0000-0000-0000-000000000000"

◆ Standard_GUID() [4/6]

Standard_GUID::Standard_GUID ( const Standard_Integer  a32b,
const Standard_ExtCharacter  a16b1,
const Standard_ExtCharacter  a16b2,
const Standard_ExtCharacter  a16b3,
const Standard_Byte  a8b1,
const Standard_Byte  a8b2,
const Standard_Byte  a8b3,
const Standard_Byte  a8b4,
const Standard_Byte  a8b5,
const Standard_Byte  a8b6 
)

◆ Standard_GUID() [5/6]

Standard_GUID::Standard_GUID ( const Standard_UUID aGuid)

◆ Standard_GUID() [6/6]

Standard_GUID::Standard_GUID ( const Standard_GUID aGuid)

Member Function Documentation

◆ Assign() [1/2]

void Standard_GUID::Assign ( const Standard_GUID uid)

◆ Assign() [2/2]

void Standard_GUID::Assign ( const Standard_UUID uid)

◆ CheckGUIDFormat()

static Standard_Boolean Standard_GUID::CheckGUIDFormat ( const Standard_CString  aGuid)
static

Check the format of a GUID string. It checks the size, the position of the '-' and the correct size of fields.

◆ Hash()

Standard_Integer Standard_GUID::Hash ( const Standard_Integer  Upper) const

Hash function for GUID.

◆ HashCode()

static Standard_Integer Standard_GUID::HashCode ( const Standard_GUID theGUID,
Standard_Integer  theUpperBound 
)
static

Computes a hash code for the given GUID of the Standard_Integer type, in the range [1, theUpperBound].

Parameters
theGUIDthe GUID which hash code is to be computed
theUpperBoundthe upper bound of the range a computing hash code must be within
Returns
a computed hash code, in the range [1, theUpperBound]

◆ IsEqual()

static Standard_Boolean Standard_GUID::IsEqual ( const Standard_GUID string1,
const Standard_GUID string2 
)
static

Returns True when the two GUID are the same.

◆ IsNotSame()

Standard_Boolean Standard_GUID::IsNotSame ( const Standard_GUID uid) const

◆ IsSame()

Standard_Boolean Standard_GUID::IsSame ( const Standard_GUID uid) const

◆ operator!=()

Standard_Boolean Standard_GUID::operator!= ( const Standard_GUID uid) const
inline

◆ operator=() [1/2]

void Standard_GUID::operator= ( const Standard_GUID uid)
inline

◆ operator=() [2/2]

void Standard_GUID::operator= ( const Standard_UUID uid)
inline

◆ operator==()

Standard_Boolean Standard_GUID::operator== ( const Standard_GUID uid) const
inline

◆ ShallowDump()

void Standard_GUID::ShallowDump ( Standard_OStream aStream) const

Display the GUID with the following format:

"00000000-0000-0000-0000-000000000000"

◆ ToCString()

void Standard_GUID::ToCString ( const Standard_PCharacter  aStrGuid) const

translate the GUID into ascii string the aStrGuid is allocated by user. the guid have the following format:

"00000000-0000-0000-0000-000000000000"

◆ ToExtString()

void Standard_GUID::ToExtString ( const Standard_PExtCharacter  aStrGuid) const

translate the GUID into unicode string the aStrGuid is allocated by user. the guid have the following format:

"00000000-0000-0000-0000-000000000000"

◆ ToUUID()

Standard_UUID Standard_GUID::ToUUID ( ) const

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