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

OmmError represents received Omm data who fails to process properly. More...

Inheritance diagram for refinitiv::ema::access::OmmError:
refinitiv::ema::access::Data

Public Types

enum  ErrorCode {
  NoErrorEnum = 0 ,
  NoDictionaryEnum = 1 ,
  IteratorSetFailureEnum = 2 ,
  IteratorOverrunEnum = 3 ,
  FieldIdNotFoundEnum = 4 ,
  IncompleteDataEnum = 5 ,
  UnsupportedDataTypeEnum = 6 ,
  NoSetDefinitionEnum = 7 ,
  UnknownErrorEnum = 8
}
 
- Public Types inherited from refinitiv::ema::access::Data
enum  DataCode {
  NoCodeEnum = 0 ,
  BlankEnum = 1
}
 

Accessors

class Decoder
 
class StaticDecoder
 
const EmaStringgetErrorCodeAsString () const
  More...
 
DataType::DataTypeEnum getDataType () const
  More...
 
Data::DataCode getCode () const
  More...
 
const EmaBuffergetAsHex () const
  More...
 
const EmaStringtoString () const
  More...
 
ErrorCode getErrorCode () const
  More...
 

Additional Inherited Members

- Public Member Functions inherited from refinitiv::ema::access::Data
const EmaStringgetCodeAsString () const
  More...
 
 operator const char * () const
  More...
 
virtual ~Data ()
  More...
 
- Protected Member Functions inherited from refinitiv::ema::access::Data
 Data ()
 

Detailed Description

Objects of OmmError class are returned when an error is detected while processing received data. These objects are used for debugging purposes only.

void decodeData( const Data& rcvdData )
{
if ( rcvdData.getCode() != Data::BlankEnum )
switch ( rcvdData.getDataType() )
{
UInt64 value = static_cast< const OmmUInt& >( rcvdData ).getUInt();
break;
...
cout << "Failed to decode data. Error code is: "
<< static_cast< OmmError& >( rcvdData ).getErrorCodeAsString() << "\n"
<< "Received data is: "
<< rcvdData.getAsHex() << "\n";
break;
}
}
unsigned long long UInt64
represents 64-bit unsigned integer
Definition: Common.h:68
const EmaString & getErrorCodeAsString() const
Remarks
OmmError is a read only class.
The usage of this class is limited to downcast operation only.
All methods in this class are Lock-free Method.
See also
Data, EmaString, EmaBuffer

Definition at line 62 of file OmmError.h.

Member Enumeration Documentation

◆ ErrorCode

An enumeration representing decoding error condition.

Enumerator
NoErrorEnum 

Indicates no error

NoDictionaryEnum 

Indicates missing dictionary

IteratorSetFailureEnum 

Indicates internal iterator set failure

IteratorOverrunEnum 

Indicates internal iterator overrun failure

FieldIdNotFoundEnum 

Indicates field id was not found in dictionary

IncompleteDataEnum 

Indicates incomplete data

UnsupportedDataTypeEnum 

Indicates unsupported data type

NoSetDefinitionEnum 

Indicates set defined data is not present

UnknownErrorEnum 

Indicates unknown error

Definition at line 69 of file OmmError.h.

Member Function Documentation

◆ getAsHex()

const EmaBuffer& refinitiv::ema::access::OmmError::getAsHex ( ) const
virtual

Returns a buffer that in turn provides an alphanumeric null-terminated hexadecimal string representation.

Returns
EmaBuffer with the message hex information

Implements refinitiv::ema::access::Data.

◆ getCode()

Data::DataCode refinitiv::ema::access::OmmError::getCode ( ) const
virtual

Returns the Code, which indicates a special state of a DataType.

Returns
Data::NoCodeEnum

Implements refinitiv::ema::access::Data.

◆ getDataType()

DataType::DataTypeEnum refinitiv::ema::access::OmmError::getDataType ( ) const
virtual

Returns the DataType, which is the type of Omm data. Results in this class type.

Returns
DataType::ErrorEnum

Implements refinitiv::ema::access::Data.

◆ getErrorCode()

ErrorCode refinitiv::ema::access::OmmError::getErrorCode ( ) const

Returns ErrorCode.

Returns
error code

◆ getErrorCodeAsString()

const EmaString& refinitiv::ema::access::OmmError::getErrorCodeAsString ( ) const

Returns the ErrorCode value as a string format.

Returns
string representation of error code (e.g., "IteratorSetFailure" )

◆ toString()

const EmaString& refinitiv::ema::access::OmmError::toString ( ) const
virtual

Returns a string representation of the class instance.

Returns
string representation of the class instance

Implements refinitiv::ema::access::Data.