OnixS C++ CME iLink 3 Binary Order Entry Handler 1.18.9
API Documentation
Loading...
Searching...
No Matches
SbeGroupEntries< EntryType, BlockLength, NumInGroup, Length > Class Template Reference

Classes

class  Iterator

Public Types

typedef Length EncodedLength
typedef EntryType Entry
typedef NumInGroup Size

Public Member Functions

 SbeGroupEntries () noexcept
 SbeGroupEntries (void *encoded, BlockLength blockLength, Size groupSize, SchemaVersion version) noexcept
bool valid () const noexcept
bool empty () const noexcept
Size size () const noexcept
Iterator begin () const
Iterator end () const
Entry operator[] (Size index) const
void * encoded () const noexcept
EncodedLength encodedLength () const noexcept
template<class OtherEntry, class OtherBlockLength, class OtherNumInGroup, class OtherLength>
 SbeGroupEntries (const SbeGroupEntries< OtherEntry, OtherBlockLength, OtherNumInGroup, OtherLength > &other) noexcept
template<class OtherEntry, class OtherBlockLength, class OtherNumInGroup, class OtherLength>
SbeGroupEntriesoperator= (const SbeGroupEntries< OtherEntry, OtherBlockLength, OtherNumInGroup, OtherLength > &other) noexcept

Friends

template<class OtherEntry, class OtherBlockLength, class OtherNumInGroup, class OtherLength>
class SbeGroupEntries

Detailed Description

template<class EntryType, class BlockLength, class NumInGroup, class Length>
class OnixS::CME::iLink3::Messaging::SbeGroupEntries< EntryType, BlockLength, NumInGroup, Length >

Definition at line 378 of file SbeMessage.h.

Member Typedef Documentation

◆ EncodedLength

template<class EntryType, class BlockLength, class NumInGroup, class Length>
typedef Length EncodedLength

The length of the binary data occupied by the group entries.

Definition at line 382 of file SbeMessage.h.

◆ Entry

template<class EntryType, class BlockLength, class NumInGroup, class Length>
typedef EntryType Entry

The type of the repeating group entry.

Definition at line 385 of file SbeMessage.h.

◆ Size

template<class EntryType, class BlockLength, class NumInGroup, class Length>
typedef NumInGroup Size

Number of entries in the collection.

Definition at line 388 of file SbeMessage.h.

Constructor & Destructor Documentation

◆ SbeGroupEntries() [1/3]

template<class EntryType, class BlockLength, class NumInGroup, class Length>
SbeGroupEntries ( )
inlinenoexcept

Initializes a blank instance referencing to nothing.

Definition at line 512 of file SbeMessage.h.

◆ SbeGroupEntries() [2/3]

template<class EntryType, class BlockLength, class NumInGroup, class Length>
SbeGroupEntries ( void * encoded,
BlockLength blockLength,
Size groupSize,
SchemaVersion version )
inlinenoexcept

Initializes the instance referencing to data.

Definition at line 521 of file SbeMessage.h.

◆ SbeGroupEntries() [3/3]

template<class EntryType, class BlockLength, class NumInGroup, class Length>
template<class OtherEntry, class OtherBlockLength, class OtherNumInGroup, class OtherLength>
SbeGroupEntries ( const SbeGroupEntries< OtherEntry, OtherBlockLength, OtherNumInGroup, OtherLength > & other)
inlinenoexcept

Copy constructor.

Definition at line 587 of file SbeMessage.h.

Member Function Documentation

◆ begin()

template<class EntryType, class BlockLength, class NumInGroup, class Length>
Iterator begin ( ) const
inline
Returns
the iterator pointing to the first repeating group entry.

Definition at line 551 of file SbeMessage.h.

◆ empty()

template<class EntryType, class BlockLength, class NumInGroup, class Length>
bool empty ( ) const
inlinenoexcept
Returns
true if the referenced repeating group is empty, otherwise - false.

Definition at line 539 of file SbeMessage.h.

◆ encoded()

template<class EntryType, class BlockLength, class NumInGroup, class Length>
void * encoded ( ) const
inlinenoexcept
Returns
Binary data occupied by the group entries.

Definition at line 574 of file SbeMessage.h.

◆ encodedLength()

template<class EntryType, class BlockLength, class NumInGroup, class Length>
EncodedLength encodedLength ( ) const
inlinenoexcept
Returns
the length of the binary data occupied by the group entries.

Definition at line 580 of file SbeMessage.h.

◆ end()

template<class EntryType, class BlockLength, class NumInGroup, class Length>
Iterator end ( ) const
inline

Returns the iterator pointing to the entry behind the end of the group.

Definition at line 557 of file SbeMessage.h.

◆ operator=()

template<class EntryType, class BlockLength, class NumInGroup, class Length>
template<class OtherEntry, class OtherBlockLength, class OtherNumInGroup, class OtherLength>
SbeGroupEntries & operator= ( const SbeGroupEntries< OtherEntry, OtherBlockLength, OtherNumInGroup, OtherLength > & other)
inlinenoexcept

Definition at line 601 of file SbeMessage.h.

◆ operator[]()

template<class EntryType, class BlockLength, class NumInGroup, class Length>
Entry operator[] ( Size index) const
inline

Provides access to the group entry by its index in the repeating group.

Note
Index validness is not checked due to performance considerations.

Definition at line 565 of file SbeMessage.h.

◆ size()

template<class EntryType, class BlockLength, class NumInGroup, class Length>
Size size ( ) const
inlinenoexcept
Returns
number of blocks.

Definition at line 545 of file SbeMessage.h.

◆ valid()

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

Definition at line 533 of file SbeMessage.h.

◆ SbeGroupEntries

template<class EntryType, class BlockLength, class NumInGroup, class Length>
template<class OtherEntry, class OtherBlockLength, class OtherNumInGroup, class OtherLength>
friend class SbeGroupEntries
friend

Definition at line 620 of file SbeMessage.h.