BinaryFields< Block, BlockSize > Class Template Reference

Protected Member Functions
	BinaryFields ()
	~BinaryFields ()
template<class FieldValue>
const FieldValue &	ordinary (BlockSize offset) const
template<class FieldValue, class NullValue>
bool	ordinary (FieldValue &value, BlockSize offset, const NullValue &null) const
template<class Value>
Decimal	decimal (BlockSize offset) const
template<class NullValue>
bool	decimal (Decimal &value, BlockSize offset, const NullValue &null) const
template<class FieldValue, class NullValue>
bool	ordinary (FieldValue &value, BlockSize offset, const NullValue &null, SchemaVersion since) const
template<class Enumeration>
Enumeration::Enum	enumeration (BlockSize offset) const
template<class Enumeration, class NullValue>
bool	enumeration (typename Enumeration::Enum &value, BlockSize offset, const NullValue &null) const
template<class Enumeration, class NullValue>
bool	enumeration (typename Enumeration::Enum &value, BlockSize offset, const NullValue &null, SchemaVersion since) const
template<BlockSize Size>
StrRef	fixedStr (BlockSize offset) const
template<BlockSize Size>
StrRef	fixedStr (BlockSize offset, SchemaVersion since) const
template<BlockSize Size>
bool	fixedStr (StrRef &value, BlockSize offset) const

Detailed Description

template<class Block, class BlockSize>
class OnixS::CME::Streamlined::MDH::BinaryFields< Block, BlockSize >

Class represents an abstraction, instance construction available through descendants implementing actual access to encoded data.

Definition at line 43 of file BinaryMessage.h.

Constructor & Destructor Documentation

BinaryFields()

template<class Block, class BlockSize>

BinaryFields ( )

inlineprotected

Initializes blank instance.

Definition at line 54 of file BinaryMessage.h.

~BinaryFields()

template<class Block, class BlockSize>

~BinaryFields ( )

inlineprotected

Cleans everything up.

Definition at line 59 of file BinaryMessage.h.

Member Function Documentation

decimal() [1/2]

template<class Block, class BlockSize>

template<class Value>

Decimal decimal ( BlockSize offset ) const

inlineprotected

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

Definition at line 126 of file BinaryMessage.h.

decimal() [2/2]

template<class Block, class BlockSize>

template<class NullValue>

bool decimal ( Decimal & value, BlockSize 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 146 of file BinaryMessage.h.

enumeration() [1/3]

template<class Block, class BlockSize>

template<class Enumeration>

Enumeration::Enum enumeration ( BlockSize 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 212 of file BinaryMessage.h.

enumeration() [2/3]

template<class Block, class BlockSize>

template<class Enumeration, class NullValue>

bool enumeration ( typename Enumeration::Enum & value, BlockSize 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 241 of file BinaryMessage.h.

enumeration() [3/3]

template<class Block, class BlockSize>

template<class Enumeration, class NullValue>

bool enumeration ( typename Enumeration::Enum & value, BlockSize 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 281 of file BinaryMessage.h.

fixedStr() [1/3]

template<class Block, class BlockSize>

template<BlockSize Size>

StrRef fixedStr ( BlockSize 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 304 of file BinaryMessage.h.

fixedStr() [2/3]

template<class Block, class BlockSize>

template<BlockSize Size>

StrRef fixedStr ( BlockSize 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 330 of file BinaryMessage.h.

fixedStr() [3/3]

template<class Block, class BlockSize>

template<BlockSize Size>

bool fixedStr ( StrRef & value, BlockSize offset ) 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 353 of file BinaryMessage.h.

ordinary() [1/3]

template<class Block, class BlockSize>

template<class FieldValue>

const FieldValue & ordinary ( BlockSize offset ) const

inlineprotected

Returns value of a field by its offset.

Definition at line 70 of file BinaryMessage.h.

ordinary() [2/3]

template<class Block, class BlockSize>

template<class FieldValue, class NullValue>

bool ordinary ( FieldValue & value, BlockSize 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 101 of file BinaryMessage.h.

ordinary() [3/3]

template<class Block, class BlockSize>

template<class FieldValue, class NullValue>

bool ordinary ( FieldValue & value, BlockSize 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 188 of file BinaryMessage.h.