OnixS C++ CME Market Data Handler  5.4.0
API documentation
BinaryGroup< EntryType, DimensionType, LengthType > Class Template Reference

#include <OnixS/CME/MDH/BinaryMessage.h>

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 1001 of file BinaryMessage.h.

Member Typedef Documentation

typedef DimensionType Dimension

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

Definition at line 1006 of file BinaryMessage.h.

typedef LengthType EncodedLength

Measures binary length of the group.

Definition at line 1031 of file BinaryMessage.h.

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

Binary group blocks.

Definition at line 1019 of file BinaryMessage.h.

Aliases type of the group entry.

Definition at line 1025 of file BinaryMessage.h.

typedef Entries::Iterator Iterator

Defines type of iterator for group entries.

Definition at line 1022 of file BinaryMessage.h.

Type representing a number of entries in the group.

Definition at line 1028 of file BinaryMessage.h.

Constructor & Destructor Documentation

BinaryGroup ( )
inline

Initializes blank instance referencing to nothing.

Definition at line 1034 of file BinaryMessage.h.

BinaryGroup ( const void *  encoded,
EncodedLength  length,
SchemaVersion  version 
)
inline

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

Definition at line 1041 of file BinaryMessage.h.

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

Initializes instance as a copy of the other one.

Definition at line 1079 of file BinaryMessage.h.

Member Function Documentation

Iterator begin ( ) const
inline

Returns iterator pointing to the first repeating group entry.

Definition at line 1109 of file BinaryMessage.h.

bool empty ( ) const
inline

Indicates whether a repeating group being referenced is empty.

Definition at line 1095 of file BinaryMessage.h.

const void* encoded ( ) const
inline

SBE-encoded data representing the given repeating group.

Definition at line 1139 of file BinaryMessage.h.

EncodedLength encodedLength ( ) const
inline

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

Definition at line 1146 of file BinaryMessage.h.

Iterator end ( ) const
inline

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

Definition at line 1116 of file BinaryMessage.h.

const Entries& entries ( ) const
inline

Location of repeating group entries.

Definition at line 1132 of file BinaryMessage.h.

operator bool ( ) const
inline

Indicates whether given instance refers to a valid repeating group.

Definition at line 1088 of file BinaryMessage.h.

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

Re-initializes instance as copy of the other one.

Definition at line 1156 of file BinaryMessage.h.

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 1126 of file BinaryMessage.h.

Size size ( ) const
inline

Returns number of entries in a repeating group being referenced.

Definition at line 1102 of file BinaryMessage.h.


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