OnixS C++ B3 BOE Binary Order Entry  1.2.0
API Documentation
SbeFields< Container, BlockLength > Class Template Reference

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

Public Member Functions

Container & container () noexcept
 
void zeroPaddingBytes (BlockLength offset) noexcept
 
template<class FieldValue >
void setOrdinary (BlockLength offset, FieldValue value) noexcept
 
template<class FieldValue >
void setOrdinary (BlockLength offset, FieldValue value, SchemaVersion since)
 
template<class Enumeration >
void setEnumeration (BlockLength offset, typename Enumeration::Enum value) noexcept
 
template<class Enumeration >
void setEnumeration (BlockLength offset, typename Enumeration::Enum value, SchemaVersion since)
 
template<BlockLength Size>
void setFixedStr (BlockLength offset, StrRef value) noexcept
 
template<BlockLength Size>
void setFixedStr (BlockLength offset, StrRef value, SchemaVersion since)
 

Protected Member Functions

 SbeFields ()=default
 
 ~SbeFields ()=default
 
- Protected Member Functions inherited from BinaryBlock< Container, BlockLength >
 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::SbeFields< Container, BlockLength >

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

Definition at line 223 of file SbeMessage.h.

Constructor & Destructor Documentation

SbeFields ( )
protecteddefault

Initializes a blank instance.

~SbeFields ( )
protecteddefault

Member Function Documentation

Container& container ( )
inlinenoexcept
Returns
The block container that provides access to the encoded data.

Definition at line 227 of file SbeMessage.h.

void setEnumeration ( BlockLength  offset,
typename Enumeration::Enum  value 
)
inlinenoexcept

Sets the field value.

Definition at line 266 of file SbeMessage.h.

void setEnumeration ( BlockLength  offset,
typename Enumeration::Enum  value,
SchemaVersion  since 
)
inline

Sets the field value.

Definition at line 274 of file SbeMessage.h.

void setFixedStr ( BlockLength  offset,
StrRef  value 
)
inlinenoexcept

Sets the field value.

Definition at line 282 of file SbeMessage.h.

void setFixedStr ( BlockLength  offset,
StrRef  value,
SchemaVersion  since 
)
inline

Sets the field value.

Definition at line 298 of file SbeMessage.h.

void setOrdinary ( BlockLength  offset,
FieldValue  value 
)
inlinenoexcept

Sets the field value.

Definition at line 246 of file SbeMessage.h.

void setOrdinary ( BlockLength  offset,
FieldValue  value,
SchemaVersion  since 
)
inline

Sets the field value.

Definition at line 256 of file SbeMessage.h.

void zeroPaddingBytes ( BlockLength  offset)
inlinenoexcept

If specified, the extra space is padded at the end of each entry and should be set to zeroes by encoders.

Definition at line 234 of file SbeMessage.h.


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