Products Support Documentation Download
RDM_CPP::rdm_exception Class Reference

the rdm_exception class This class implements the exception thrown by the RDM CPP API More...

#include "cpp-exception.h"

Inheritance diagram for RDM_CPP::rdm_exception:
Collaboration diagram for RDM_CPP::rdm_exception:

Public Member Functions

 rdm_exception (RDM_RETCODE error)
 rdm_exception constructor More...
 
virtual const char * GetDescription () const throw ()
 method to get a text description of the error causing the exception to be thrown More...
 
virtual const char * GetEnum () const throw ()
 
RDM_RETCODE GetErrorCode (void) const
 method to get the RDM error number More...
 

Protected Attributes

RDM_RETCODE m_error
 

Detailed Description

the rdm_exception class This class implements the exception thrown by the RDM CPP API

Examples:
tutorials/HelloWorldCPP/hello_worldCPPTutorial_main.cpp.

Definition at line 48 of file cpp-exception.h.

Constructor & Destructor Documentation

◆ rdm_exception()

RDM_CPP::rdm_exception::rdm_exception ( RDM_RETCODE  error)

rdm_exception constructor

Member Function Documentation

◆ GetDescription()

virtual const char* RDM_CPP::rdm_exception::GetDescription ( ) const
throw (
)
virtual

method to get a text description of the error causing the exception to be thrown

Examples:
tutorials/HelloWorldCPP/hello_worldCPPTutorial_main.cpp.

◆ GetEnum()

virtual const char* RDM_CPP::rdm_exception::GetEnum ( ) const
throw (
)
virtual

◆ GetErrorCode()

RDM_RETCODE RDM_CPP::rdm_exception::GetErrorCode ( void  ) const

method to get the RDM error number

Field Documentation

◆ m_error

RDM_RETCODE RDM_CPP::rdm_exception::m_error
protected

Definition at line 62 of file cpp-exception.h.


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