CFx SDK Documentation  2023 SP0
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
OdTrVisUniqueID Class Reference

#include <TrVisUniqueId.h>

Classes

class  DefUIDTransformer
 
class  DefUIDUnTransformer
 
class  UIDTransformer
 
class  UIDUnTransformer
 

Public Types

enum  IDType { kPersistentID = 0 , kTransientID , kUtilitaryID }
 

Public Member Functions

 OdTrVisUniqueID ()
 
 OdTrVisUniqueID (const OdTrVisUniqueID &ui)
 
 OdTrVisUniqueID (OdUInt64 entryId, OdUInt32 entryType=kTransientID, OdUInt64 entryData=0)
 
OdTrVisUniqueIDoperator= (const OdTrVisUniqueID &ui)
 
bool operator== (const OdTrVisUniqueID &ui) const
 
bool operator!= (const OdTrVisUniqueID &ui) const
 
bool isValid () const
 
void setId (OdUInt64 nId)
 
void setId (const void *pId)
 
OdUInt64 getId () const
 
OdDbStub * persistentId () const
 
void setData (OdUInt64 nData)
 
OdUInt64 getData () const
 
void setPersistent ()
 
bool isPersistent () const
 
void setTransient ()
 
bool isTransient () const
 
void setUtilitary (OdUInt32 utCode=kUtilitaryID)
 
bool isUtilitary () const
 
OdUInt32 getType () const
 
bool operator< (const OdTrVisUniqueID &t2) const
 
bool operator<= (const OdTrVisUniqueID &t2) const
 
bool operator> (const OdTrVisUniqueID &t2) const
 
bool operator>= (const OdTrVisUniqueID &t2) const
 
OdAnsiString transform (const UIDTransformer &transformer=DefUIDTransformer()) const
 
OdTrVisUniqueIDuntransform (const char *pStr, const UIDUnTransformer &untransformer=DefUIDUnTransformer())
 
 OdTrVisUniqueID (const OdAnsiString &asValue, const UIDUnTransformer &untransformer=DefUIDUnTransformer())
 

Static Public Member Functions

static int compare (const OdTrVisUniqueID &t1, const OdTrVisUniqueID &t2)
 

Protected Attributes

OdUInt64 m_entryId
 
OdUInt64 m_entryData
 
OdUInt32 m_entryType
 

Detailed Description

<group ExRender_Windows_Classes>

Definition at line 37 of file TrVisUniqueId.h.

Member Enumeration Documentation

◆ IDType

Enumerator
kPersistentID 
kTransientID 
kUtilitaryID 

Definition at line 40 of file TrVisUniqueId.h.

Constructor & Destructor Documentation

◆ OdTrVisUniqueID() [1/4]

OdTrVisUniqueID::OdTrVisUniqueID ( )
inline

Definition at line 51 of file TrVisUniqueId.h.

◆ OdTrVisUniqueID() [2/4]

OdTrVisUniqueID::OdTrVisUniqueID ( const OdTrVisUniqueID ui)
inline

Definition at line 57 of file TrVisUniqueId.h.

◆ OdTrVisUniqueID() [3/4]

OdTrVisUniqueID::OdTrVisUniqueID ( OdUInt64  entryId,
OdUInt32  entryType = kTransientID,
OdUInt64  entryData = 0 
)
inline

Definition at line 63 of file TrVisUniqueId.h.

◆ OdTrVisUniqueID() [4/4]

OdTrVisUniqueID::OdTrVisUniqueID ( const OdAnsiString &  asValue,
const UIDUnTransformer untransformer = DefUIDUnTransformer() 
)
inline

Definition at line 254 of file TrVisUniqueId.h.

Member Function Documentation

◆ compare()

static int OdTrVisUniqueID::compare ( const OdTrVisUniqueID t1,
const OdTrVisUniqueID t2 
)
inlinestatic

Definition at line 109 of file TrVisUniqueId.h.

◆ getData()

OdUInt64 OdTrVisUniqueID::getData ( ) const
inline

Definition at line 99 of file TrVisUniqueId.h.

◆ getId()

OdUInt64 OdTrVisUniqueID::getId ( ) const
inline

Definition at line 95 of file TrVisUniqueId.h.

◆ getType()

OdUInt32 OdTrVisUniqueID::getType ( ) const
inline

Definition at line 107 of file TrVisUniqueId.h.

◆ isPersistent()

bool OdTrVisUniqueID::isPersistent ( ) const
inline

Definition at line 102 of file TrVisUniqueId.h.

◆ isTransient()

bool OdTrVisUniqueID::isTransient ( ) const
inline

Definition at line 104 of file TrVisUniqueId.h.

◆ isUtilitary()

bool OdTrVisUniqueID::isUtilitary ( ) const
inline

Definition at line 106 of file TrVisUniqueId.h.

◆ isValid()

bool OdTrVisUniqueID::isValid ( void  ) const
inline

Definition at line 91 of file TrVisUniqueId.h.

◆ operator!=()

bool OdTrVisUniqueID::operator!= ( const OdTrVisUniqueID ui) const
inline

Definition at line 84 of file TrVisUniqueId.h.

◆ operator<()

bool OdTrVisUniqueID::operator< ( const OdTrVisUniqueID t2) const
inline

Definition at line 121 of file TrVisUniqueId.h.

◆ operator<=()

bool OdTrVisUniqueID::operator<= ( const OdTrVisUniqueID t2) const
inline

Definition at line 122 of file TrVisUniqueId.h.

◆ operator=()

OdTrVisUniqueID& OdTrVisUniqueID::operator= ( const OdTrVisUniqueID ui)
inline

Definition at line 68 of file TrVisUniqueId.h.

◆ operator==()

bool OdTrVisUniqueID::operator== ( const OdTrVisUniqueID ui) const
inline

Definition at line 78 of file TrVisUniqueId.h.

◆ operator>()

bool OdTrVisUniqueID::operator> ( const OdTrVisUniqueID t2) const
inline

Definition at line 123 of file TrVisUniqueId.h.

◆ operator>=()

bool OdTrVisUniqueID::operator>= ( const OdTrVisUniqueID t2) const
inline

Definition at line 124 of file TrVisUniqueId.h.

◆ persistentId()

OdDbStub* OdTrVisUniqueID::persistentId ( ) const
inline

Definition at line 96 of file TrVisUniqueId.h.

◆ setData()

void OdTrVisUniqueID::setData ( OdUInt64  nData)
inline

Definition at line 98 of file TrVisUniqueId.h.

◆ setId() [1/2]

void OdTrVisUniqueID::setId ( const void pId)
inline

Definition at line 94 of file TrVisUniqueId.h.

◆ setId() [2/2]

void OdTrVisUniqueID::setId ( OdUInt64  nId)
inline

Definition at line 93 of file TrVisUniqueId.h.

◆ setPersistent()

void OdTrVisUniqueID::setPersistent ( )
inline

Definition at line 101 of file TrVisUniqueId.h.

◆ setTransient()

void OdTrVisUniqueID::setTransient ( )
inline

Definition at line 103 of file TrVisUniqueId.h.

◆ setUtilitary()

void OdTrVisUniqueID::setUtilitary ( OdUInt32  utCode = kUtilitaryID)
inline

Definition at line 105 of file TrVisUniqueId.h.

◆ transform()

OdAnsiString OdTrVisUniqueID::transform ( const UIDTransformer transformer = DefUIDTransformer()) const
inline

Definition at line 158 of file TrVisUniqueId.h.

◆ untransform()

OdTrVisUniqueID& OdTrVisUniqueID::untransform ( const char *  pStr,
const UIDUnTransformer untransformer = DefUIDUnTransformer() 
)
inline

Definition at line 225 of file TrVisUniqueId.h.

Member Data Documentation

◆ m_entryData

OdUInt64 OdTrVisUniqueID::m_entryData
protected

Definition at line 48 of file TrVisUniqueId.h.

◆ m_entryId

OdUInt64 OdTrVisUniqueID::m_entryId
protected

Definition at line 47 of file TrVisUniqueId.h.

◆ m_entryType

OdUInt32 OdTrVisUniqueID::m_entryType
protected

Definition at line 49 of file TrVisUniqueId.h.


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