#include <DbHandle.h>

Public Member Functions
	OdDbHandle ()

	OdDbHandle (const OdDbHandle &value)=default

template<class T, std::enable_if< OdDbHandleConvertible< typename std::remove_reference< typename std::remove_cv< T >::type >::type >::value > * = nullptr>
	OdDbHandle (T value)

	OdDbHandle (OdUInt64 value)

	OdDbHandle (const OdChar *value)

	OdDbHandle (const char *value)

	OdDbHandle (const OdString &value)

	OdDbHandle (const OdAnsiString &value)

	OdDbHandle (int value)

OdDbHandle &	operator= (OdUInt64 value)

OdDbHandle &	operator= (const OdChar *value)

OdDbHandle &	operator= (const char *value)

OdDbHandle &	operator= (const OdDbHandle &value)=default

OdDbHandle &	operator= (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

OdDbHandle &	operator+= (const OdInt64 &value)

OdDbHandle	operator+ (const OdInt64 &value)

void	bytes (OdUInt8 *bytes) const

Detailed Description

Definition at line 77 of file DbHandle.h.

Constructor & Destructor Documentation

◆ OdDbHandle() [1/9]

OdDbHandle::OdDbHandle ( )

inline

Default constructor for instances of the OdDbHandle class.

Remarks: Initializes the handle with the null value.

Definition at line 86 of file DbHandle.h.

◆ OdDbHandle() [2/9]

OdDbHandle::OdDbHandle ( const OdDbHandle & value )

default

Copy constructor for instances of the OdDbHandle class.

Parameters

value [in] Reference to an OdDbHandle value.

◆ OdDbHandle() [3/9]

template<class T, std::enable_if< OdDbHandleConvertible< typename std::remove_reference< typename std::remove_cv< T >::type >::type >::value > * = nullptr>

OdDbHandle::OdDbHandle ( T value )

inline

Constructoor for instances of the OdDbHandle class.

Parameters

value [in] Value to convert.

Remarks: The value is converted to the OdUInt64 type.

Definition at line 105 of file DbHandle.h.

◆ OdDbHandle() [4/9]

OdDbHandle::OdDbHandle ( OdUInt64 value )

inline

Constructor for a handle using the specified 64-bit handle value.

Parameters

value [in] OdUInt64 value.

Definition at line 113 of file DbHandle.h.

◆ OdDbHandle() [5/9]

OdDbHandle::OdDbHandle ( const OdChar * value )

inline

Constructor for a handle from a pointer to an OdChar value.

Parameters

value [in] Pointer to an OdChar value.

Definition at line 120 of file DbHandle.h.

◆ OdDbHandle() [6/9]

OdDbHandle::OdDbHandle ( const char * value )

inline

Constructor for a handle from a pointer to a char value.

Parameters

value [in] Pointer to an char value.

Definition at line 127 of file DbHandle.h.

◆ OdDbHandle() [7/9]

OdDbHandle::OdDbHandle ( const OdString & value )

inline

Constructor for a handle from a specified OdString value.

Parameters

value [in] An OdString value.

Definition at line 134 of file DbHandle.h.

◆ OdDbHandle() [8/9]

OdDbHandle::OdDbHandle ( const OdAnsiString & value )

inline

Constructor for a handle from a specified OdAnsiString value.

Parameters

value [in] An OdAnsiString value.

Definition at line 141 of file DbHandle.h.

◆ OdDbHandle() [9/9]

OdDbHandle::OdDbHandle ( int value )

inline

Constructor for a handle from a specified int value.

Parameters

value [in] An int value.

Definition at line 148 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 this handle object as an array of OdUInt8[8] values.

Parameters

bytes [in] Array of low-ordered 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 322 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 230 of file DbHandle.h.

◆ operator OdUInt64()

OdDbHandle::operator OdUInt64 ( ) const

inline

Returns a converted instance of the OdDbHandle class as an OdUInt64 value.

Returns: The instance of the OdDbHandle class as an OdUInt64 value.

Definition at line 211 of file DbHandle.h.

◆ operator!=()

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

inline

Compares the value of an instance of the OdDbHandle class and a specified value.

Parameters

value [in] OdUInt64 value to compare with.

Returns: The true value if the value of the OdDbHandle class instance and the specified value are not equal, or false otherwise.

Definition at line 247 of file DbHandle.h.

◆ operator+()

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

inline

Returns the result of adding a specified value to the value of the OdDbHandle class instance.

Returns: Returns the result of adding a value.

Remarks: The value of an instance of the OdDbHandle class is not changed.

Definition at line 306 of file DbHandle.h.

◆ operator+=()

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

inline

Adds a specified value to the value of this OdDbHandle object.

Returns: Returns the updated value of this OdDbHandle class.

Remarks: The value of this OdDbHandle class is changed.

Definition at line 292 of file DbHandle.h.

◆ operator<()

bool OdDbHandle::operator< ( OdUInt64 value ) const

inline

Compares the value of an instance of the OdDbHandle class and a specified value.

Parameters

value [in] OdUInt64 value to compare with.

Returns: The true value if the value of the OdDbHandle class instance is smaller than the specified value, or false otherwise.

Definition at line 265 of file DbHandle.h.

◆ operator<=()

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

inline

Compares the value of an instance of the OdDbHandle class and a specified value.

Parameters

value [in] OdUInt64 value to compare with.

Returns: The true value if the value of the OdDbHandle class instance is less than or equal to the specified value, or false otherwise.

Definition at line 274 of file DbHandle.h.

◆ operator=() [1/5]

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

Assignment operator. Assigns a new char value to this OdDbHandle object, replacing its current contents.

Parameters

value [in] Pointer to a char value.

Returns: Reference to this object.

◆ operator=() [2/5]

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

Assignment operator. Assigns a new OdChar value to this OdDbHandle object, replacing its current contents.

Parameters

value [in] Pointer to an OdChar value.

Returns: Reference to this object.

◆ operator=() [3/5]

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

default

Copy assignment operator. Assigns a new value to this OdDbHandle object, replacing its current contents.

Parameters

value [in] New OdDbHandle value.

Returns: Reference to this object.

◆ operator=() [4/5]

OdDbHandle & OdDbHandle::operator= ( int value )

inline

Assignment operator. Assigns a new int value to this OdDbHandle object, replacing its current contents.

Parameters

value [in] New int value.

Returns: Reference to this object.

Definition at line 200 of file DbHandle.h.

◆ operator=() [5/5]

OdDbHandle & OdDbHandle::operator= ( OdUInt64 value )

inline

Assignment operator. Assigns a new OdUInt64 value to this OdDbHandle object, replacing its current contents.

Parameters

value [in] New OdUInt64 value.

Returns: Reference to this object.

Definition at line 164 of file DbHandle.h.

◆ operator==()

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

inline

Compares the value of an instance of the OdDbHandle class and a specified value.

Parameters

value [in] OdUInt64 value to compare with.

Returns: The true value if the value of the OdDbHandle class instance and the specified value are equal, or false otherwise.

Definition at line 238 of file DbHandle.h.

◆ operator>()

bool OdDbHandle::operator> ( OdUInt64 value ) const

inline

Compares the value of an instance of the OdDbHandle class and a specified value.

Parameters

value [in] OdUInt64 value to compare with.

Returns: The true value if the value of the OdDbHandle class instance is bigger than the specified value, or false otherwise.

Definition at line 256 of file DbHandle.h.

◆ operator>=()

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

inline

Compares the value of an instance of the OdDbHandle class and a specified value.

Parameters

value [in] OdUInt64 value to compare with.

Returns: The true value if the value of the OdDbHandle class instance is greater than or equal to the specified value, or false otherwise.

Definition at line 283 of file DbHandle.h.

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

DbHandle.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ OdDbHandle() [1/9]

◆ OdDbHandle() [2/9]

◆ OdDbHandle() [3/9]

◆ OdDbHandle() [4/9]

◆ OdDbHandle() [5/9]

◆ OdDbHandle() [6/9]

◆ OdDbHandle() [7/9]

◆ OdDbHandle() [8/9]

◆ OdDbHandle() [9/9]

Member Function Documentation

◆ ascii()

◆ bytes()

◆ getIntoAsciiBuffer()

◆ isNull()

◆ operator OdUInt64()

◆ operator!=()

◆ operator+()

◆ operator+=()

◆ operator<()

◆ operator<=()

◆ operator=() [1/5]

◆ operator=() [2/5]

◆ operator=() [3/5]

◆ operator=() [4/5]

◆ operator=() [5/5]

◆ operator==()

◆ operator>()

◆ operator>=()