EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members | Public Types | Protected Member Functions | Protected Attributes
thomsonreuters::ema::access::OmmException Class Referenceabstract

OmmException is a parent class for all exception types thrown by EMA. More...

Inheritance diagram for thomsonreuters::ema::access::OmmException:
thomsonreuters::ema::access::OmmInaccessibleLogFileException thomsonreuters::ema::access::OmmInvalidConfigurationException thomsonreuters::ema::access::OmmInvalidHandleException thomsonreuters::ema::access::OmmInvalidUsageException thomsonreuters::ema::access::OmmJsonConverterException thomsonreuters::ema::access::OmmMemoryExhaustionException thomsonreuters::ema::access::OmmOutOfRangeException thomsonreuters::ema::access::OmmSystemException thomsonreuters::ema::access::OmmUnsupportedDomainTypeException

Public Types

enum  ExceptionType {
  OmmInvalidUsageExceptionEnum,
  OmmInvalidConfigurationExceptionEnum,
  OmmSystemExceptionEnum,
  OmmOutOfRangeExceptionEnum,
  OmmInvalidHandleExceptionEnum,
  OmmMemoryExhaustionExceptionEnum,
  OmmInaccessibleLogFileExceptionEnum,
  OmmUnsupportedDomainTypeExceptionEnum,
  OmmJsonConverterExceptionEnum
}
 

Public Member Functions

Accessors
const EmaStringgetExceptionTypeAsString () const
 
virtual ExceptionType getExceptionType () const =0
 
virtual const EmaStringgetText () const =0
 
virtual const EmaStringtoString () const =0
 
 operator const char * () const
 

Protected Member Functions

 OmmException ()
 
 OmmException (const OmmException &)
 
OmmExceptionoperator= (const OmmException &)
 
OmmExceptionstatusText (const EmaString &statusText)
 
OmmExceptionstatusText (const char *statusText)
 
const EmaStringtoStringInt () const
 
virtual ~OmmException ()
 

Protected Attributes

char _errorText [MAX_SIZE]
 
UInt32 _errorTextLength
 
char _space [MAX_SIZE_PLUS_PADDING]
 

Detailed Description

This class provides all the common functionalities and methods used by the inheriting classes.

Remarks
All methods in this class are Lock-free Method.
See Also
OmmInaccessibleLogFileException, OmmInvalidHandleException, OmmInvalidUsageException, OmmMemoryExhaustionException, OmmOutOfRangeException, OmmSystemException, OmmUnsupportedDomainTypeException, OmmConsumerErrorClient, OmmProviderErrorClient

Definition at line 45 of file OmmException.h.

Member Enumeration Documentation

An enumeration representing exception type.

Enumerator
OmmInvalidUsageExceptionEnum 

Indicates invalid usage exception

OmmInvalidConfigurationExceptionEnum 

Indicates invalid configuration exception

OmmSystemExceptionEnum 

Indicates system exception

OmmOutOfRangeExceptionEnum 

Indicates out of range exception

OmmInvalidHandleExceptionEnum 

Indicates invalid handle exception

OmmMemoryExhaustionExceptionEnum 

Indicates memory exhaustion exception

OmmInaccessibleLogFileExceptionEnum 

Indicates inaccessible log file exception

OmmUnsupportedDomainTypeExceptionEnum 

Indicates unsupported domain type exception

OmmJsonConverterExceptionEnum 

Indicates JSON converter exception

Definition at line 52 of file OmmException.h.

Constructor & Destructor Documentation

thomsonreuters::ema::access::OmmException::OmmException ( )
protected
virtual thomsonreuters::ema::access::OmmException::~OmmException ( )
protectedvirtual
thomsonreuters::ema::access::OmmException::OmmException ( const OmmException )
protected

Member Function Documentation

virtual ExceptionType thomsonreuters::ema::access::OmmException::getExceptionType ( ) const
pure virtual
const EmaString& thomsonreuters::ema::access::OmmException::getExceptionTypeAsString ( ) const

Returns the ExceptionType value as a string format.

Returns
string representation of this object's exception type as string
virtual const EmaString& thomsonreuters::ema::access::OmmException::getText ( ) const
pure virtual
thomsonreuters::ema::access::OmmException::operator const char * ( ) const

Operator const char* overload.

Remarks
allows std::cout << ommException;
Returns
const char* used for printing
OmmException& thomsonreuters::ema::access::OmmException::operator= ( const OmmException )
protected
OmmException& thomsonreuters::ema::access::OmmException::statusText ( const EmaString statusText)
protected
OmmException& thomsonreuters::ema::access::OmmException::statusText ( const char *  statusText)
protected
virtual const EmaString& thomsonreuters::ema::access::OmmException::toString ( ) const
pure virtual
const EmaString& thomsonreuters::ema::access::OmmException::toStringInt ( ) const
protected

Member Data Documentation

char thomsonreuters::ema::access::OmmException::_errorText[MAX_SIZE]
mutableprotected

Definition at line 113 of file OmmException.h.

UInt32 thomsonreuters::ema::access::OmmException::_errorTextLength
protected

Definition at line 112 of file OmmException.h.

char thomsonreuters::ema::access::OmmException::_space[MAX_SIZE_PLUS_PADDING]
mutableprotected

Definition at line 114 of file OmmException.h.