BinaryBlock< Container, BlockLength > Class Template Reference

#include <OnixS/B3/BOE/messaging/SbeMessage.h>

Protected Member Functions
	BinaryBlock ()=default
	~BinaryBlock ()=default
template<class Value>
Value	ordinary (BlockLength offset) const noexcept
template<class Value>
const Value &	accessOrdinary (BlockLength offset) const noexcept
template<class Value>
Value &	accessOrdinary (BlockLength offset) 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::B3::BOE::Messaging::BinaryBlock< Container, BlockLength >

Services to access fields stored in an 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 64 of file SbeMessage.h.

Constructor & Destructor Documentation

BinaryBlock()

template<class Container, class BlockLength>

BinaryBlock ( )

protecteddefault

Initializes a blank instance.

~BinaryBlock()

template<class Container, class BlockLength>

~BinaryBlock ( )

protecteddefault

Member Function Documentation

accessOrdinary() [1/2]

template<class Container, class BlockLength>

template<class Value>

const Value & accessOrdinary ( BlockLength offset ) const

inlineprotectednoexcept

Returns

constant reference to the field value.

Definition at line 91 of file SbeMessage.h.

accessOrdinary() [2/2]

template<class Container, class BlockLength>

template<class Value>

Value & accessOrdinary ( BlockLength offset )

inlineprotectednoexcept

Returns

reference to the field value.

Definition at line 103 of file SbeMessage.h.

decimal() [1/3]

template<class Container, class BlockLength>

template<class Value>

Value decimal ( BlockLength offset ) const

inlineprotectednoexcept

Returns

a Decimal field value.

Definition at line 160 of file SbeMessage.h.

decimal() [2/3]

template<class Container, class BlockLength>

template<class Value, class NullValue>

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 170 of file SbeMessage.h.

decimal() [3/3]

template<class Container, class BlockLength>

template<class Value, class NullValue>

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 181 of file SbeMessage.h.

enumeration() [1/3]

template<class Container, class BlockLength>

template<class Enumeration>

Enumeration::Enum enumeration ( BlockLength offset ) const

inlineprotectednoexcept

Returns

the field value.

Definition at line 132 of file SbeMessage.h.

enumeration() [2/3]

template<class Container, class BlockLength>

template<class Enumeration, class NullValue>

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

inlineprotectednoexcept

Provides access to an optional field value.

Definition at line 142 of file SbeMessage.h.

enumeration() [3/3]

template<class Container, class BlockLength>

template<class Enumeration, class NullValue>

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

inlineprotectednoexcept

Provides access to an optional field value.

Definition at line 153 of file SbeMessage.h.

fixedStr() [1/3]

template<class Container, class BlockLength>

template<BlockLength Length>

StrRef fixedStr ( BlockLength offset ) const

inlineprotectednoexcept

Provides access to a string field value.

Definition at line 188 of file SbeMessage.h.

fixedStr() [2/3]

template<class Container, class BlockLength>

template<BlockLength Length>

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 202 of file SbeMessage.h.

fixedStr() [3/3]

template<class Container, class BlockLength>

template<BlockLength Length>

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 213 of file SbeMessage.h.

ordinary() [1/3]

template<class Container, class BlockLength>

template<class Value>

Value ordinary ( BlockLength offset ) const

inlineprotectednoexcept

Returns

the field value.

Definition at line 80 of file SbeMessage.h.

ordinary() [2/3]

template<class Container, class BlockLength>

template<class Value, class NullValue>

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 113 of file SbeMessage.h.

ordinary() [3/3]

template<class Container, class BlockLength>

template<class Value, class NullValue>

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 125 of file SbeMessage.h.