CFx SDK Documentation  2023 SP0
Public Member Functions | List of all members
OdDbHandle Class Reference

#include <DbHandle.h>

Public Member Functions

 OdDbHandle ()
 
 OdDbHandle (const OdDbHandle &value)
 
 OdDbHandle (OdUInt64 value)
 
 OdDbHandle (const OdChar *value)
 
 OdDbHandle (const char *value)
 
 OdDbHandle (const OdString &value)
 
 OdDbHandle (const OdAnsiString &value)
 
 OdDbHandle (int value)
 
OdDbHandleoperator= (OdUInt64 value)
 
OdDbHandleoperator= (const OdChar *value)
 
OdDbHandleoperator= (const char *value)
 
OdDbHandleoperator= (const OdDbHandle &value)
 
OdDbHandleoperator= (int value)
 
 operator OdUInt64 () const
 
void getIntoAsciiBuffer (OdChar *pBuf) const
 
OdString ascii () const
 
bool isNull () const
 
bool operator== (OdUInt64 value) const
 
bool operator!= (OdUInt64 value) const
 
bool operator> (OdUInt64 value) const
 
bool operator< (OdUInt64 value) const
 
bool operator<= (OdUInt64 value) const
 
bool operator>= (OdUInt64 value) const
 
OdDbHandleoperator+= (const OdInt64 &value)
 
OdDbHandle operator+ (const OdInt64 &value)
 
void bytes (OdUInt8 *bytes) const
 

Detailed Description

Returns the 64 bit integer value corresponding to the passed in string.

Parameters
pStr[in] String representation of an integer.

This class encapsulates the 64-bit integer handles associated with OdDbObject instances.

Corresponding C++ library: TD_Db

Remarks
Handles are persistent and unique within a database. Handles are not, however, unique between databases.

<group OdDb_Classes>

Definition at line 66 of file DbHandle.h.

Constructor & Destructor Documentation

◆ OdDbHandle() [1/8]

OdDbHandle::OdDbHandle ( )
inline

Definition at line 69 of file DbHandle.h.

◆ OdDbHandle() [2/8]

OdDbHandle::OdDbHandle ( const OdDbHandle value)
inline

Definition at line 71 of file DbHandle.h.

◆ OdDbHandle() [3/8]

OdDbHandle::OdDbHandle ( OdUInt64  value)
inline

Definition at line 73 of file DbHandle.h.

◆ OdDbHandle() [4/8]

OdDbHandle::OdDbHandle ( const OdChar value)
inline

Definition at line 75 of file DbHandle.h.

◆ OdDbHandle() [5/8]

OdDbHandle::OdDbHandle ( const char *  value)
inline

Definition at line 76 of file DbHandle.h.

◆ OdDbHandle() [6/8]

OdDbHandle::OdDbHandle ( const OdString value)
inline

Definition at line 77 of file DbHandle.h.

◆ OdDbHandle() [7/8]

OdDbHandle::OdDbHandle ( const OdAnsiString &  value)
inline

Definition at line 78 of file DbHandle.h.

◆ OdDbHandle() [8/8]

OdDbHandle::OdDbHandle ( int  value)
inline

Definition at line 79 of file DbHandle.h.

Member Function Documentation

◆ ascii()

OdString OdDbHandle::ascii ( ) const

Returns the hexidecmal representation of this Handle object as an OdString.

◆ bytes()

void OdDbHandle::bytes ( OdUInt8 bytes) const
inline

Returns the this Handle object as an array OdUInt8[8].

Parameters
bytes[in] array of bytes to receive the handle.
Remarks
The low order byte is returned in bytes[0].
The buffer must be at least 17 bytes long.

Definition at line 169 of file DbHandle.h.

◆ getIntoAsciiBuffer()

void OdDbHandle::getIntoAsciiBuffer ( OdChar pBuf) const

Returns the hexidecmal representation of this Handle object as a null terminated string.

Parameters
pBuf[in] Pointer to the buffer to receive the string.
Remarks
The buffer must be at least 17 bytes long.

◆ isNull()

bool OdDbHandle::isNull ( ) const
inline

Returns true and only if this Handle object is null.

Definition at line 123 of file DbHandle.h.

◆ operator OdUInt64()

OdDbHandle::operator OdUInt64 ( ) const
inline

Definition at line 103 of file DbHandle.h.

◆ operator!=()

bool OdDbHandle::operator!= ( OdUInt64  value) const
inline

Definition at line 128 of file DbHandle.h.

◆ operator+()

OdDbHandle OdDbHandle::operator+ ( const OdInt64 value)
inline

Definition at line 150 of file DbHandle.h.

◆ operator+=()

OdDbHandle& OdDbHandle::operator+= ( const OdInt64 value)
inline

Definition at line 143 of file DbHandle.h.

◆ operator<()

bool OdDbHandle::operator< ( OdUInt64  value) const
inline

Definition at line 134 of file DbHandle.h.

◆ operator<=()

bool OdDbHandle::operator<= ( OdUInt64  value) const
inline

Definition at line 137 of file DbHandle.h.

◆ operator=() [1/5]

OdDbHandle& OdDbHandle::operator= ( const char *  value)

◆ operator=() [2/5]

OdDbHandle& OdDbHandle::operator= ( const OdChar value)

◆ operator=() [3/5]

OdDbHandle& OdDbHandle::operator= ( const OdDbHandle value)
inline

Definition at line 92 of file DbHandle.h.

◆ operator=() [4/5]

OdDbHandle& OdDbHandle::operator= ( int  value)
inline

Definition at line 97 of file DbHandle.h.

◆ operator=() [5/5]

OdDbHandle& OdDbHandle::operator= ( OdUInt64  value)
inline

Definition at line 83 of file DbHandle.h.

◆ operator==()

bool OdDbHandle::operator== ( OdUInt64  value) const
inline

Definition at line 125 of file DbHandle.h.

◆ operator>()

bool OdDbHandle::operator> ( OdUInt64  value) const
inline

Definition at line 131 of file DbHandle.h.

◆ operator>=()

bool OdDbHandle::operator>= ( OdUInt64  value) const
inline

Definition at line 140 of file DbHandle.h.


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