OnixS C++ B3 BOE Binary Order Entry 1.3.0
API Documentation
Loading...
Searching...
No Matches
SbeGroup< EntryType, DimensionType, GroupSizeType > Class Template Reference

Public Types

enum  
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::B3::BOE::Messaging::SbeGroup< EntryType, DimensionType, GroupSizeType >

Definition at line 649 of file SbeMessage.h.

Member Typedef Documentation

◆ BinarySize

template<class EntryType, class DimensionType, class GroupSizeType>
typedef GroupSizeType BinarySize

Length of group data.

Definition at line 656 of file SbeMessage.h.

◆ Dimension

template<class EntryType, class DimensionType, class GroupSizeType>
typedef DimensionType Dimension

Repeating group dimension type.

Definition at line 653 of file SbeMessage.h.

◆ Entries

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

Binary group blocks.

Definition at line 665 of file SbeMessage.h.

◆ Entry

template<class EntryType, class DimensionType, class GroupSizeType>
typedef Entries::Entry Entry

Group entry type.

Definition at line 671 of file SbeMessage.h.

◆ EntrySize

template<class EntryType, class DimensionType, class GroupSizeType>
typedef DimensionType::BlockLength EntrySize

Length of group entry data.

Definition at line 662 of file SbeMessage.h.

◆ Iterator

template<class EntryType, class DimensionType, class GroupSizeType>
typedef Entries::Iterator Iterator

The iterator type for group entries.

Definition at line 668 of file SbeMessage.h.

◆ Size

template<class EntryType, class DimensionType, class GroupSizeType>
typedef Entries::Size Size

Number of entries in the group.

Definition at line 674 of file SbeMessage.h.

Member Enumeration Documentation

◆ anonymous enum

template<class EntryType, class DimensionType, class GroupSizeType>
anonymous enum

Length of an empty group.

Enumerator
EmptySize Dimension::Size 

Definition at line 659 of file SbeMessage.h.

Constructor & Destructor Documentation

◆ SbeGroup() [1/2]

template<class EntryType, class DimensionType, class GroupSizeType>
SbeGroup ( )
inlinenoexcept

Initializes a blank instance referencing to nothing.

Definition at line 677 of file SbeMessage.h.

◆ SbeGroup() [2/2]

template<class EntryType, class DimensionType, class GroupSizeType>
SbeGroup ( void * data,
BinarySize size,
SchemaVersion version )
inlinenoexcept

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

Definition at line 687 of file SbeMessage.h.

Member Function Documentation

◆ begin()

template<class EntryType, class DimensionType, class GroupSizeType>
Iterator begin ( ) const
inlinenoexcept
Returns
an iterator pointing to the first repeating group entry.

Definition at line 727 of file SbeMessage.h.

◆ binary()

template<class EntryType, class DimensionType, class GroupSizeType>
void * binary ( ) const
inlinenoexcept
Returns
SBE-encoded data that represents the repeating group.

Definition at line 779 of file SbeMessage.h.

◆ binarySize()

template<class EntryType, class DimensionType, class GroupSizeType>
BinarySize binarySize ( ) const
inlinenoexcept
Returns
the size of SBE-encoded data that represents the repeating group.

Definition at line 786 of file SbeMessage.h.

◆ empty()

template<class EntryType, class DimensionType, class GroupSizeType>
bool empty ( ) const
inlinenoexcept
Returns
true if the repeating group is empty, otherwise - false.

Definition at line 706 of file SbeMessage.h.

◆ encoded()

template<class EntryType, class DimensionType, class GroupSizeType>
const void * encoded ( ) const
inlinenoexcept
Returns
SBE-encoded data that represents the repeating group.

Definition at line 766 of file SbeMessage.h.

◆ end()

template<class EntryType, class DimensionType, class GroupSizeType>
Iterator end ( ) const
inlinenoexcept
Returns
an iterator pointing to the entry behind the end of the group.

Definition at line 736 of file SbeMessage.h.

◆ entries()

template<class EntryType, class DimensionType, class GroupSizeType>
Entries entries ( ) const
inlinenoexcept
Returns
Repeating group entries.

Definition at line 757 of file SbeMessage.h.

◆ entrySize()

template<class EntryType, class DimensionType, class GroupSizeType>
EntrySize entrySize ( ) const
inlinenoexcept
Returns
the size of a single repeating group entry.

Definition at line 793 of file SbeMessage.h.

◆ operator[]()

template<class EntryType, class DimensionType, class GroupSizeType>
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 747 of file SbeMessage.h.

◆ size()

template<class EntryType, class DimensionType, class GroupSizeType>
Size size ( ) const
inlinenoexcept
Returns
the number of entries in the repeating group.

Definition at line 715 of file SbeMessage.h.

◆ tail()

template<class EntryType, class DimensionType, class GroupSizeType>
const void * tail ( ) const
inlinenoexcept
Returns
the end of SBE-encoded data that represents the repeating group.

Definition at line 772 of file SbeMessage.h.

◆ valid()

template<class EntryType, class DimensionType, class GroupSizeType>
bool valid ( ) const
inlinenoexcept
Returns
true if the instance refers to a valid repeating group, otherwise - false.

Definition at line 700 of file SbeMessage.h.

◆ SbeMessage

template<class EntryType, class DimensionType, class GroupSizeType>
friend class SbeMessage
friend

Definition at line 901 of file SbeMessage.h.