Standard_GUID Class Reference

#include <Standard_GUID.hxx>

Public Member Functions
constexpr	Standard_GUID () noexcept
	Creates a GUID with all zeros.
	Standard_GUID (const char *const aGuid)
	build a GUID from an ascii string with the following format: Length : 36 char "00000000-0000-0000-0000-000000000000"
	Standard_GUID (const char16_t *const aGuid)
	build a GUID from an unicode string with the following format:
constexpr	Standard_GUID (const int a32b, const char16_t a16b1, const char16_t a16b2, const char16_t a16b3, const uint8_t a8b1, const uint8_t a8b2, const uint8_t a8b3, const uint8_t a8b4, const uint8_t a8b5, const uint8_t a8b6) noexcept
	Creates a GUID from the given components.
constexpr	Standard_GUID (const Standard_UUID &theUUID) noexcept
	Creates a GUID from a Standard_UUID.
constexpr	Standard_GUID (const Standard_GUID &theGuid) noexcept=default
	Copy constructor.
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:
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:
constexpr Standard_UUID	ToUUID () const noexcept
	Converts to Standard_UUID.
constexpr bool	IsSame (const Standard_GUID &uid) const noexcept
	Returns true if this GUID is equal to uid.
constexpr bool	operator== (const Standard_GUID &uid) const noexcept
constexpr bool	IsNotSame (const Standard_GUID &uid) const noexcept
	Returns true if this GUID is not equal to uid.
constexpr bool	operator!= (const Standard_GUID &uid) const noexcept
constexpr void	Assign (const Standard_GUID &uid) noexcept
	Assigns uid to this GUID.
constexpr Standard_GUID &	operator= (const Standard_GUID &uid) noexcept
constexpr void	Assign (const Standard_UUID &uid) noexcept
	Assigns uid to this GUID.
constexpr Standard_GUID &	operator= (const Standard_UUID &uid) noexcept
void	ShallowDump (Standard_OStream &aStream) const
	Display the GUID with the following format:

Static Public Member Functions
static bool	CheckGUIDFormat (const char *const aGuid)
	Check the format of a GUID string. It checks the size, the position of the '-' and the correct size of fields.

Constructor & Destructor Documentation

Standard_GUID() [1/6]

constexpr Standard_GUID::Standard_GUID ( )

inlineconstexprnoexcept

Creates a GUID with all zeros.

Standard_GUID() [2/6]

Standard_GUID::Standard_GUID

(

const char *const

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 char16_t *const

aGuid

)

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

"00000000-0000-0000-0000-000000000000"

Standard_GUID() [4/6]

constexpr Standard_GUID::Standard_GUID ( const int a32b, const char16_t a16b1, const char16_t a16b2, const char16_t a16b3, const uint8_t a8b1, const uint8_t a8b2, const uint8_t a8b3, const uint8_t a8b4, const uint8_t a8b5, const uint8_t a8b6 )

inlineconstexprnoexcept

Creates a GUID from the given components.

Standard_GUID() [5/6]

constexpr Standard_GUID::Standard_GUID ( const Standard_UUID & theUUID )

inlineconstexprnoexcept

Creates a GUID from a Standard_UUID.

Standard_GUID() [6/6]

constexpr Standard_GUID::Standard_GUID ( const Standard_GUID & theGuid )

constexprdefaultnoexcept

Copy constructor.

Member Function Documentation

Assign() [1/2]

constexpr void Standard_GUID::Assign ( const Standard_GUID & uid )

inlineconstexprnoexcept

Assigns uid to this GUID.

Assign() [2/2]

constexpr void Standard_GUID::Assign ( const Standard_UUID & uid )

inlineconstexprnoexcept

Assigns uid to this GUID.

CheckGUIDFormat()

static bool Standard_GUID::CheckGUIDFormat ( const char *const aGuid )

static

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

IsNotSame()

constexpr bool Standard_GUID::IsNotSame ( const Standard_GUID & uid ) const

inlineconstexprnoexcept

Returns true if this GUID is not equal to uid.

IsSame()

constexpr bool Standard_GUID::IsSame ( const Standard_GUID & uid ) const

inlineconstexprnoexcept

Returns true if this GUID is equal to uid.

operator!=()

constexpr bool Standard_GUID::operator!= ( const Standard_GUID & uid ) const

inlineconstexprnoexcept

operator=() [1/2]

constexpr Standard_GUID & Standard_GUID::operator= ( const Standard_GUID & uid )

inlineconstexprnoexcept

operator=() [2/2]

constexpr Standard_GUID & Standard_GUID::operator= ( const Standard_UUID & uid )

inlineconstexprnoexcept

operator==()

constexpr bool Standard_GUID::operator== ( const Standard_GUID & uid ) const

inlineconstexprnoexcept

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()

constexpr Standard_UUID Standard_GUID::ToUUID ( ) const

inlineconstexprnoexcept

Converts to Standard_UUID.

---

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

• Standard_GUID.hxx