EMA C++ Edition
List of all members | Public Types
refinitiv::ema::access::OmmException Class Referenceabstract

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

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

Public Types

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

Accessors

UInt32 _errorTextLength
 
UInt32 _errorTextPadding
 
char _errorText [MAX_SIZE]
 
char _space [MAX_SIZE_PLUS_PADDING]
 
const EmaStringgetExceptionTypeAsString () const
  More...
 
virtual ExceptionType getExceptionType () const =0
  More...
 
virtual const EmaStringgetText () const =0
  More...
 
virtual const EmaStringtoString () const =0
  More...
 
 operator const char * () const
  More...
 
 OmmException ()
 
virtual ~OmmException ()
 
OmmExceptionstatusText (const EmaString &statusText)
 
OmmExceptionstatusText (const char *statusText)
 
const EmaStringtoStringInt () const
 
 OmmException (const OmmException &)
 
OmmExceptionoperator= (const OmmException &)
 

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

◆ ExceptionType

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.

Member Function Documentation

◆ getExceptionType()

virtual ExceptionType refinitiv::ema::access::OmmException::getExceptionType ( ) const
pure virtual

◆ getExceptionTypeAsString()

const EmaString& refinitiv::ema::access::OmmException::getExceptionTypeAsString ( ) const

Returns the ExceptionType value as a string format.

Returns
string representation of this object's exception type as string

◆ getText()

virtual const EmaString& refinitiv::ema::access::OmmException::getText ( ) const
pure virtual

◆ operator const char *()

refinitiv::ema::access::OmmException::operator const char * ( ) const

Operator const char* overload.

Remarks
allows std::cout << ommException;
Returns
const char* used for printing

◆ toString()

virtual const EmaString& refinitiv::ema::access::OmmException::toString ( ) const
pure virtual