OnixS C++ CME MDP Premium Market Data Handler 5.9.0
API Documentation
Loading...
Searching...
No Matches
BinaryGroup< EntryType, DimensionType, LengthType > Class Template Reference

Public Types

typedef DimensionType Dimension
typedef BinaryGroupEntries< EntryType, typename Dimension::BlockLength, typename Dimension::NumInGroup, LengthType > Entries
typedef Entries::Iterator Iterator
typedef Entries::Entry Entry
typedef Entries::Size Size
typedef LengthType EncodedLength

Public Member Functions

 BinaryGroup ()
 BinaryGroup (const void *encoded, EncodedLength length, SchemaVersion version)
 BinaryGroup (const BinaryGroup &other)
 operator bool () const
bool empty () const
Size size () const
Iterator begin () const
Iterator end () const
Entry operator[] (Size index) const
const Entriesentries () const
const void * encoded () const
EncodedLength encodedLength () const
BinaryGroupoperator= (const BinaryGroup &other)

Detailed Description

template<class EntryType, class DimensionType, class LengthType>
class OnixS::CME::MDH::BinaryGroup< EntryType, DimensionType, LengthType >

Definition at line 637 of file BinaryMessage.h.

Member Typedef Documentation

◆ Dimension

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

Binary group dimensions (actual length, number of entries, etc).

Definition at line 642 of file BinaryMessage.h.

◆ EncodedLength

template<class EntryType, class DimensionType, class LengthType>
typedef LengthType EncodedLength

Measures binary length of the group.

Definition at line 658 of file BinaryMessage.h.

◆ Entries

template<class EntryType, class DimensionType, class LengthType>
typedef BinaryGroupEntries<EntryType, typename Dimension::BlockLength, typename Dimension::NumInGroup, LengthType> Entries

Binary group blocks.

Definition at line 646 of file BinaryMessage.h.

◆ Entry

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

Aliases type of the group entry.

Definition at line 652 of file BinaryMessage.h.

◆ Iterator

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

Defines type of iterator for group entries.

Definition at line 649 of file BinaryMessage.h.

◆ Size

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

Type representing a number of entries in the group.

Definition at line 655 of file BinaryMessage.h.

Constructor & Destructor Documentation

◆ BinaryGroup() [1/3]

template<class EntryType, class DimensionType, class LengthType>
BinaryGroup ( )
inline

Initializes blank instance referencing to nothing.

Definition at line 661 of file BinaryMessage.h.

◆ BinaryGroup() [2/3]

template<class EntryType, class DimensionType, class LengthType>
BinaryGroup ( const void * encoded,
EncodedLength length,
SchemaVersion version )
inline

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

Definition at line 668 of file BinaryMessage.h.

◆ BinaryGroup() [3/3]

template<class EntryType, class DimensionType, class LengthType>
BinaryGroup ( const BinaryGroup< EntryType, DimensionType, LengthType > & other)
inline

Initializes instance as a copy of the other one.

Definition at line 689 of file BinaryMessage.h.

Member Function Documentation

◆ begin()

template<class EntryType, class DimensionType, class LengthType>
Iterator begin ( ) const
inline

Returns iterator pointing to the first repeating group entry.

Definition at line 718 of file BinaryMessage.h.

◆ empty()

template<class EntryType, class DimensionType, class LengthType>
bool empty ( ) const
inline

Indicates whether a repeating group being referenced is empty.

Definition at line 704 of file BinaryMessage.h.

◆ encoded()

template<class EntryType, class DimensionType, class LengthType>
const void * encoded ( ) const
inline

SBE-encoded data representing the given repeating group.

Definition at line 748 of file BinaryMessage.h.

◆ encodedLength()

template<class EntryType, class DimensionType, class LengthType>
EncodedLength encodedLength ( ) const
inline

Length of the SBE-encoded data representing the given group.

Definition at line 755 of file BinaryMessage.h.

◆ end()

template<class EntryType, class DimensionType, class LengthType>
Iterator end ( ) const
inline

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

Definition at line 725 of file BinaryMessage.h.

◆ entries()

template<class EntryType, class DimensionType, class LengthType>
const Entries & entries ( ) const
inline

Location of repeating group entries.

Definition at line 741 of file BinaryMessage.h.

◆ operator bool()

template<class EntryType, class DimensionType, class LengthType>
operator bool ( ) const
inline

Indicates whether given instance refers to a valid repeating group.

Definition at line 697 of file BinaryMessage.h.

◆ operator=()

template<class EntryType, class DimensionType, class LengthType>
BinaryGroup & operator= ( const BinaryGroup< EntryType, DimensionType, LengthType > & other)
inline

Re-initializes instance as copy of the other one.

Definition at line 761 of file BinaryMessage.h.

◆ operator[]()

template<class EntryType, class DimensionType, class LengthType>
Entry operator[] ( Size index) const
inline

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

Index validness is not checked due to performance considerations.

Definition at line 735 of file BinaryMessage.h.

◆ size()

template<class EntryType, class DimensionType, class LengthType>
Size size ( ) const
inline

Returns number of entries in a repeating group being referenced.

Definition at line 711 of file BinaryMessage.h.