OnixS C++ CME iLink 3 Binary Order Entry Handler  1.14.0
API Documentation
SbeGroup< EntryType, DimensionType, GroupSizeType > Class Template Reference

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

Public Types

enum  { EmptySize = Dimension::Size }
 
typedef DimensionType Dimension
 
typedef GroupSizeType BinarySize
 
typedef DimensionType::BlockLength EntrySize
 
typedef SbeGroupEntries< EntryType, typename Dimension::BlockLength, typename Dimension::NumInGroup, GroupSizeType > Entries
 
typedef Entries::Iterator Iterator
 
typedef Entries::Entry Entry
 
typedef Entries::Size Size
 

Public Member Functions

 SbeGroup () noexcept
 
 SbeGroup (void *data, BinarySize size, SchemaVersion version) noexcept
 
bool valid () const noexcept
 
bool empty () const noexcept
 
Size size () const noexcept
 
Iterator begin () const noexcept
 
Iterator end () const noexcept
 
Entry operator[] (Size index) const
 
Entries entries () const noexcept
 
const void * encoded () const noexcept
 
const void * tail () const noexcept
 
void * binary () const noexcept
 
BinarySize binarySize () const noexcept
 
EntrySize entrySize () const noexcept
 

Friends

class SbeMessage
 

Detailed Description

template<class EntryType, class DimensionType, class GroupSizeType>
class OnixS::CME::iLink3::Messaging::SbeGroup< EntryType, DimensionType, GroupSizeType >

Definition at line 630 of file SbeMessage.h.

Member Typedef Documentation

typedef GroupSizeType BinarySize

Length of group data.

Definition at line 637 of file SbeMessage.h.

typedef DimensionType Dimension

Repeating group dimension type.

Definition at line 634 of file SbeMessage.h.

typedef SbeGroupEntries<EntryType, typename Dimension::BlockLength, typename Dimension::NumInGroup, GroupSizeType > Entries

Binary group blocks.

Definition at line 646 of file SbeMessage.h.

Group entry type.

Definition at line 652 of file SbeMessage.h.

typedef DimensionType::BlockLength EntrySize

Length of group entry data.

Definition at line 643 of file SbeMessage.h.

The iterator type for group entries.

Definition at line 649 of file SbeMessage.h.

Number of entries in the group.

Definition at line 655 of file SbeMessage.h.

Member Enumeration Documentation

anonymous enum

Length of an empty group.

Enumerator
EmptySize 

Definition at line 640 of file SbeMessage.h.

Constructor & Destructor Documentation

SbeGroup ( )
inlinenoexcept

Initializes a blank instance referencing to nothing.

Definition at line 658 of file SbeMessage.h.

SbeGroup ( void *  data,
BinarySize  size,
SchemaVersion  version 
)
inlinenoexcept

Initializes an instance referencing to a valid group of a given message.

Definition at line 668 of file SbeMessage.h.

Member Function Documentation

Iterator begin ( ) const
inlinenoexcept
Returns
an iterator pointing to the first repeating group entry.

Definition at line 708 of file SbeMessage.h.

void* binary ( ) const
inlinenoexcept
Returns
SBE-encoded data that represends the repeating group.

Definition at line 760 of file SbeMessage.h.

BinarySize binarySize ( ) const
inlinenoexcept
Returns
the size of SBE-encoded data that represends the repeating group.

Definition at line 767 of file SbeMessage.h.

bool empty ( ) const
inlinenoexcept
Returns
true if the repeating group is empty, otherwise - false.

Definition at line 687 of file SbeMessage.h.

const void* encoded ( ) const
inlinenoexcept
Returns
SBE-encoded data that represents the repeating group.

Definition at line 747 of file SbeMessage.h.

Iterator end ( ) const
inlinenoexcept
Returns
an iterator pointing to the entry behind the end of the group.

Definition at line 717 of file SbeMessage.h.

Entries entries ( ) const
inlinenoexcept
Returns
Repeating group entries.

Definition at line 738 of file SbeMessage.h.

EntrySize entrySize ( ) const
inlinenoexcept
Returns
the size of a single repeating group entry.

Definition at line 774 of file SbeMessage.h.

Entry operator[] ( Size  index) const
inline

Provides access to a repeating group entry by the given index.

Note
Index validness is not checked due to performance considerations.

Definition at line 728 of file SbeMessage.h.

Size size ( ) const
inlinenoexcept
Returns
the number of entries in the repeating group.

Definition at line 696 of file SbeMessage.h.

const void* tail ( ) const
inlinenoexcept
Returns
the end of SBE-encoded data that represents the repeating group.

Definition at line 753 of file SbeMessage.h.

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

Definition at line 681 of file SbeMessage.h.

Friends And Related Function Documentation

friend class SbeMessage
friend

Definition at line 882 of file SbeMessage.h.


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