CFx SDK Documentation  2022 SP0
Public Member Functions | List of all members
TxErrorContext Class Reference

#include <DrxError.h>

Inheritance diagram for TxErrorContext:
OdErrorContext OdRxObject

Public Member Functions

 TxErrorContext ()
 
OdSmartPtr< OdErrorContextinit (const OdString &name, int nCode, const OdString &desc=OdString::kEmpty)
 
OdString description () const
 
virtual OdResult code () const
 
virtual int txAppCode () const
 
virtual OdString txAppName () const
 
- Public Member Functions inherited from OdErrorContext
virtual ~OdErrorContext ()
 
OdString completeDescription () const
 
OdErrorContextgetPreviousError () const
 
void setPreviousError (OdErrorContext *pPreviousError)
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 
- Protected Member Functions inherited from OdErrorContext
 OdErrorContext ()
 
 OdErrorContext (OdErrorContext *pPreviousError)
 
- Protected Attributes inherited from OdErrorContext
OdErrorContextm_pPreviousError
 

Detailed Description

This class implements OdErrorContext objects for TX-specific errors.

<group Other_Classes>

Definition at line 40 of file DrxError.h.

Constructor & Destructor Documentation

◆ TxErrorContext()

TxErrorContext::TxErrorContext ( )
inline

Definition at line 47 of file DrxError.h.

Member Function Documentation

◆ code()

virtual OdResult TxErrorContext::code ( ) const
inlinevirtual

Returns the OdResult code of this ErrorContext object.

Implements OdErrorContext.

Definition at line 75 of file DrxError.h.

◆ description()

OdString TxErrorContext::description ( void  ) const
inlinevirtual
Remarks
The default implementation of this function returns a string in the following format:
            Tx application <AppName> error: <number>

Implements OdErrorContext.

Definition at line 67 of file DrxError.h.

◆ init()

OdSmartPtr<OdErrorContext> TxErrorContext::init ( const OdString name,
int  nCode,
const OdString desc = OdString::kEmpty 
)
inline

Definition at line 53 of file DrxError.h.

◆ txAppCode()

virtual int TxErrorContext::txAppCode ( ) const
inlinevirtual

Definition at line 76 of file DrxError.h.

◆ txAppName()

virtual OdString TxErrorContext::txAppName ( ) const
inlinevirtual

Definition at line 77 of file DrxError.h.


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