CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
OdIfcGUID Class Reference

#include <IfcGUID.h>

Public Member Functions

 OdIfcGUID ()
 
 OdIfcGUID (const OdGUID &other)
 
OdIfcGUIDoperator= (const OdAnsiString &s)
 
OdIfcGUIDoperator= (const OdGUID &other)
 
bool operator== (const OdIfcGUID &other) const
 
bool operator!= (const OdIfcGUID &other) const
 
bool operator< (const OdIfcGUID &other) const
 
 operator const char * () const
 
 operator char * ()
 
const char * c_str () const
 
bool isValid () const
 

Static Public Member Functions

static OdIfcGUID generate ()
 

Detailed Description

A class that implements generating and storing global unique identifiers (GUID) for IFC objects.

Definition at line 35 of file IfcGUID.h.

Constructor & Destructor Documentation

◆ OdIfcGUID() [1/2]

OdIfcGUID::OdIfcGUID ( )

Creates a new IFC GUID object with default parameters.

◆ OdIfcGUID() [2/2]

OdIfcGUID::OdIfcGUID ( const OdGUID other)

Creates a new IFC GUID based on an existing OdGUID value (copy constructor).

Parameters
other[in] An OdGUID object that is used as a base for creating the IFC GUID object.

Member Function Documentation

◆ c_str()

const char * OdIfcGUID::c_str ( ) const
inline

Retrieves the constant raw pointer to the underlying string.

Returns
A raw pointer to the C++ character array.

Definition at line 114 of file IfcGUID.h.

◆ generate()

static OdIfcGUID OdIfcGUID::generate ( )
static

Generates a new IFC GUID object (pseudo constructor).

Returns
The generated GUID object.

◆ isValid()

bool OdIfcGUID::isValid ( ) const

Determines whether the IFC GUID value is valid.

Returns
true if the value is valid; otherwise the method returns false.

◆ operator char *()

OdIfcGUID::operator char * ( )

Converts the IFC GUID object's value to a C++ character array.

Returns
A raw pointer to the C++ character array.

◆ operator const char *()

OdIfcGUID::operator const char * ( ) const

Converts the IFC GUID object's value to a constant C++ character array.

Returns
A raw pointer to the C++ character array that contains the string with the IfcGUID value.

◆ operator!=()

bool OdIfcGUID::operator!= ( const OdIfcGUID other) const
inline

Inequality operator for IFC GUID objects.

Parameters
other[in] Another IFC GUID value to be compared with (right-hand operand).
Returns
true if the IFC GUID object is not equal to another IFC GUID object; otherwise, the method returns false.

Definition at line 79 of file IfcGUID.h.

◆ operator<()

bool OdIfcGUID::operator< ( const OdIfcGUID other) const
inline

The "less-than" operator for IFC GUID objects.

Parameters
other[in] Another IFC GUID value to be compared with (right-hand operand).
Returns
true if the IFC GUID value is less than the compared IFC GUID value; otherwise the operator returns false.
Remarks
The IFC GUID is less than another IFC GUID if the string representation of the IFC GUID is not equal to the string representation of another IFC GUID and the code of the first symbol that differs is less than the symbol code in the same position in the string representation of the compared IFC GUID.

Definition at line 93 of file IfcGUID.h.

◆ operator=() [1/2]

OdIfcGUID & OdIfcGUID::operator= ( const OdAnsiString &  s)

Assignment operator for IFC GUID objects.

Parameters
s[in] A new IFC GUID value to be assigned represented as an ANSI string.
Returns
A reference to the IFC GUID object modified with the assignment operation.

◆ operator=() [2/2]

OdIfcGUID & OdIfcGUID::operator= ( const OdGUID other)

Assignment operator for IFC GUID objects.

Parameters
other[in] A new GUID value to be assigned.
Returns
A reference to the IFC GUID object modified with the assignment operation.

◆ operator==()

bool OdIfcGUID::operator== ( const OdIfcGUID other) const
inline

Comparison operator for IFC GUID objects.

Parameters
other[in] Another IFC GUID value to be compared with (right-hand operand).
Returns
true if the IFC GUID object is equal to another IFC GUID object; otherwise, the method returns false.

Definition at line 69 of file IfcGUID.h.


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