OnixS C++ B3 BOE Binary Order Entry  1.2.0
API Documentation
Public Types | Public Member Functions | List of all members
SbeGroupEntry< BodySizeType > Class Template Reference

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

Public Types

typedef BodySizeType BlockLength
 

Public Member Functions

 SbeGroupEntry ()
 
 SbeGroupEntry (void *encoded, BlockLength size, SchemaVersion version)
 
bool valid () const noexcept
 
const void * encoded () const noexcept
 
void * encoded () noexcept
 
const void * block () const noexcept
 
void * block () noexcept
 
BlockLength blockLength () const noexcept
 
SchemaVersion version () const noexcept
 
- Public Member Functions inherited from SbeFields< SbeGroupEntry< BodySizeType >, BodySizeType >
SbeGroupEntry< BodySizeType > & container () noexcept
 
void zeroPaddingBytes (BodySizeTypeoffset) noexcept
 
void setOrdinary (BodySizeTypeoffset, FieldValue value) noexcept
 
void setOrdinary (BodySizeTypeoffset, FieldValue value, SchemaVersion since)
 
void setEnumeration (BodySizeTypeoffset, typename Enumeration::Enum value) noexcept
 
void setEnumeration (BodySizeTypeoffset, typename Enumeration::Enum value, SchemaVersion since)
 
void setFixedStr (BodySizeTypeoffset, StrRef value) noexcept
 
void setFixedStr (BodySizeTypeoffset, StrRef value, SchemaVersion since)
 

Additional Inherited Members

- Protected Member Functions inherited from SbeFields< SbeGroupEntry< BodySizeType >, BodySizeType >
 SbeFields ()=default
 
 ~SbeFields ()=default
 
- Protected Member Functions inherited from BinaryBlock< SbeGroupEntry< BodySizeType >, BodySizeType >
 BinaryBlock ()=default
 
 ~BinaryBlock ()=default
 
Value ordinary (BodySizeTypeoffset) const noexcept
 
bool ordinary (Value &value, BodySizeTypeoffset, NullValue null) const noexcept
 
bool ordinary (Value &value, BodySizeTypeoffset, NullValue null, SchemaVersion since) const noexcept
 
const Value & accessOrdinary (BodySizeTypeoffset) const noexcept
 
Value & accessOrdinary (BodySizeTypeoffset) noexcept
 
Enumeration::Enum enumeration (BodySizeTypeoffset) const noexcept
 
bool enumeration (typename Enumeration::Enum &value, BodySizeTypeoffset, NullValue null) const noexcept
 
bool enumeration (typename Enumeration::Enum &value, BodySizeTypeoffset, NullValue null, SchemaVersion since) const noexcept
 
Value decimal (BodySizeTypeoffset) const noexcept
 
bool decimal (Value &value, BodySizeTypeoffset, NullValue null) const noexcept
 
bool decimal (Value &value, BodySizeTypeoffset, NullValue null, SchemaVersion since) const noexcept
 
StrRef fixedStr (BodySizeTypeoffset) const noexcept
 
bool fixedStr (StrRef &value, BodySizeTypeoffset) const noexcept
 
bool fixedStr (StrRef &value, BodySizeTypeoffset, SchemaVersion since) const noexcept
 

Detailed Description

template<class BodySizeType>
class OnixS::B3::BOE::Messaging::SbeGroupEntry< BodySizeType >

Definition at line 315 of file SbeMessage.h.

Member Typedef Documentation

typedef BodySizeType BlockLength

Type to present the length of binary data of the repeating group entry.

Definition at line 319 of file SbeMessage.h.

Constructor & Destructor Documentation

SbeGroupEntry ( )
inline

Initializes a blank instance.

Definition at line 322 of file SbeMessage.h.

SbeGroupEntry ( void *  encoded,
BlockLength  size,
SchemaVersion  version 
)
inline

Initializes the instance from the memory block of the encoded message.

Definition at line 331 of file SbeMessage.h.

Member Function Documentation

const void* block ( ) const
inlinenoexcept
Returns
the pointer to the block containing fixed-length fields.

Definition at line 362 of file SbeMessage.h.

void* block ( )
inlinenoexcept
Returns
the pointer to the block containing fixed-length fields.

Definition at line 370 of file SbeMessage.h.

BlockLength blockLength ( ) const
inlinenoexcept
Returns
Block length.

Definition at line 378 of file SbeMessage.h.

const void* encoded ( ) const
inlinenoexcept
Returns
the beginning of the group entry body.

Definition at line 346 of file SbeMessage.h.

void* encoded ( )
inlinenoexcept
Returns
the beginning of the group entry body.

Definition at line 354 of file SbeMessage.h.

bool valid ( ) const
inlinenoexcept
Returns
true if the instance refers to a valid content, otherwise - false.

Definition at line 340 of file SbeMessage.h.

SchemaVersion version ( ) const
inlinenoexcept
Returns
SBE Schema version.

Definition at line 384 of file SbeMessage.h.

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