OnixS C++ CME MDP Conflated TCP Handler  1.3.4
API Documentation
BinaryBlock< Container, BlockLength > Class Template Reference

#include <OnixS/CME/ConflatedTCP/messaging/SbeMessage.h>

Protected Member Functions

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

Detailed Description

template<class Container, class BlockLength>
class OnixS::CME::ConflatedTCP::Messaging::BinaryBlock< Container, BlockLength >

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

Definition at line 63 of file SbeMessage.h.

Constructor & Destructor Documentation

BinaryBlock ( )
protecteddefault

Initializes a blank instance.

~BinaryBlock ( )
protecteddefault

Member Function Documentation

Value decimal ( BlockLength  offset) const
inlineprotectednoexcept
Returns
a Decimal field value.

Definition at line 140 of file SbeMessage.h.

bool decimal ( Value &  value,
BlockLength  offset,
NullValue  null 
) const
inlineprotectednoexcept
Returns
an optional Decimal field value.
true if the field is present in the field block and its value was copied, otherwise - false.

Definition at line 150 of file SbeMessage.h.

bool decimal ( Value &  value,
BlockLength  offset,
NullValue  null,
SchemaVersion  since 
) const
inlineprotectednoexcept
Returns
an optional Decimal field value.
true if the field is present in the field block and its value was copied, otherwise - false.

Definition at line 161 of file SbeMessage.h.

Enumeration::Enum enumeration ( BlockLength  offset) const
inlineprotectednoexcept
Returns
the field value.

Definition at line 112 of file SbeMessage.h.

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

Provides access to an optional field value.

Definition at line 122 of file SbeMessage.h.

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

Provides access to an optional field value.

Definition at line 133 of file SbeMessage.h.

StrRef fixedStr ( BlockLength  offset) const
inlineprotectednoexcept

Provides access to a string field value.

Definition at line 168 of file SbeMessage.h.

bool fixedStr ( StrRef value,
BlockLength  offset 
) const
inlineprotectednoexcept

Provides access to an optional string field value.

Returns
true if the field is present in the field block and its value was copied, otherwise - false.

Definition at line 182 of file SbeMessage.h.

bool fixedStr ( StrRef value,
BlockLength  offset,
SchemaVersion  since 
) const
inlineprotectednoexcept

Provides access to an optional string field value.

Returns
true if the field is present in the field block and its value was copied, otherwise - false.

Definition at line 193 of file SbeMessage.h.

Value ordinary ( BlockLength  offset) const
inlineprotectednoexcept
Returns
the field value.

Definition at line 79 of file SbeMessage.h.

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

Provides access to an optional field value.

Returns
true if the field is present in the field block and its value was copied, otherwise - false.

Definition at line 93 of file SbeMessage.h.

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

Provides access to an optional field value.

Returns
true if the field is present in the field block and its value was copied, otherwise - false.

Definition at line 105 of file SbeMessage.h.


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