OnixS C++ CME Market Data Handler  5.4.0
API documentation
BinaryBlock< Container, BlockLength > Class Template Reference

#include <OnixS/CME/MDH/BinaryMessage.h>

Protected Member Functions

 BinaryBlock ()
 
 ~BinaryBlock ()
 
template<class Value >
Value ordinary (BlockLength offset) const
 
template<class Value , class NullValue >
bool ordinary (Value &value, BlockLength offset, const NullValue &null) const
 
template<class Value , class NullValue >
bool ordinary (Value &value, BlockLength offset, const NullValue &null, SchemaVersion since) const
 
template<class Enumeration >
Enumeration::Enum enumeration (BlockLength offset) const
 
template<class Enumeration , class NullValue >
bool enumeration (typename Enumeration::Enum &value, BlockLength offset, const NullValue &null) const
 
template<class Enumeration , class NullValue >
bool enumeration (typename Enumeration::Enum &value, BlockLength offset, const NullValue &null, SchemaVersion since) const
 
template<class Value >
Decimal decimal (BlockLength offset) const
 
template<class NullValue >
bool decimal (Decimal &value, BlockLength offset, const NullValue &null) const
 
template<class NullValue >
bool decimal (Decimal &value, BlockLength offset, const NullValue &null, SchemaVersion since) const
 
template<BlockLength Length>
StrRef fixedStr (BlockLength offset) const
 
template<BlockLength Length>
StrRef fixedStr (BlockLength offset, SchemaVersion since) const
 

Detailed Description

template<class Container, class BlockLength>
class OnixS::CME::MDH::BinaryBlock< Container, BlockLength >

Exposes base services to access fields stored in a SBE-encoded block of fixed-length fields.

The given class represents an abstraction to be used by descendants as a base class with static polymorphism.

Definition at line 46 of file BinaryMessage.h.

Constructor & Destructor Documentation

BinaryBlock ( )
inlineprotected

Initializes the blank instance.

Definition at line 62 of file BinaryMessage.h.

~BinaryBlock ( )
inlineprotected

Ends life of the instance.

Definition at line 67 of file BinaryMessage.h.

Member Function Documentation

Decimal decimal ( BlockLength  offset) const
inlineprotected

Returns value of a field by its offset converted into a decimal.

Definition at line 288 of file BinaryMessage.h.

bool decimal ( Decimal value,
BlockLength  offset,
const NullValue &  null 
) const
inlineprotected

Provides access to a value of an optional field by its offset. The result is converted into decimal.

Returned result indicates whether field is present in given field block and its value was copied into a given parameter-variable.

Definition at line 309 of file BinaryMessage.h.

bool decimal ( Decimal value,
BlockLength  offset,
const NullValue &  null,
SchemaVersion  since 
) const
inlineprotected

Provides access to a value of an optional field by its offset. The result is converted into decimal.

Returned result indicates whether field is present in given field block and its value was copied into a given parameter-variable.

Field may not be present in earlier versions of binary message and thus its value may not be available. For this reason, parameter indicating version of data assumed is required to access the field.

Definition at line 350 of file BinaryMessage.h.

Enumeration::Enum enumeration ( BlockLength  offset) const
inlineprotected

Returns value of a field by its offset.

Given function serves as specialization of general case for fields of enumeration type.

Definition at line 185 of file BinaryMessage.h.

bool enumeration ( typename Enumeration::Enum &  value,
BlockLength  offset,
const NullValue &  null 
) const
inlineprotected

Provides access to value of an optional field by its offset.

Given function serves as specialization of general case for fields of enumeration type.

Definition at line 214 of file BinaryMessage.h.

bool enumeration ( typename Enumeration::Enum &  value,
BlockLength  offset,
const NullValue &  null,
SchemaVersion  since 
) const
inlineprotected

Provides access to value of an optional field by its offset.

Given function serves as specialization of general case for fields of enumeration type.

Definition at line 257 of file BinaryMessage.h.

StrRef fixedStr ( BlockLength  offset) const
inlineprotected

Provides access to string field by its offset.

Given function serves as specialization of general case for fields of string type.

Definition at line 379 of file BinaryMessage.h.

StrRef fixedStr ( BlockLength  offset,
SchemaVersion  since 
) const
inlineprotected

Provides access to an optional field of string type by its offset.

Given function serves as specialization of general case for fields of string type.

Definition at line 422 of file BinaryMessage.h.

Value ordinary ( BlockLength  offset) const
inlineprotected

Returns value of a field by its offset.

Definition at line 77 of file BinaryMessage.h.

bool ordinary ( Value &  value,
BlockLength  offset,
const NullValue &  null 
) const
inlineprotected

Provides access to a value of an optional field by its offset.

Returned result indicates whether field is present in given field block and its value was copied into a given parameter-variable.

Definition at line 119 of file BinaryMessage.h.

bool ordinary ( Value &  value,
BlockLength  offset,
const NullValue &  null,
SchemaVersion  since 
) const
inlineprotected

Provides access to a value of an optional field by its offset.

Returned result indicates whether field is present in given field block and its value was copied into a given parameter-variable.

Field may not be present in earlier versions of binary message and thus its value may not be available. For this reason, parameter indicating version of data assumed is required to access the field.

Definition at line 155 of file BinaryMessage.h.


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