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

#include <BinaryMessage.h>

Classes

class  Iterator
 

Public Types

typedef EntryType Entry
 
typedef DimensionType Dimension
 
typedef GroupSizeType BinarySize
 
typedef DimensionType::BlockLength EntrySize
 
typedef Dimension::NumInGroup Size
 

Public Member Functions

 BinaryGroup ()
 
 BinaryGroup (const void *data, BinarySize size, 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 void * binary () const
 
BinarySize binarySize () const
 
const void * entries () const
 
EntrySize entrySize () const
 
BinaryGroup & operator= (const BinaryGroup &other)
 

Detailed Description

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

Definition at line 500 of file BinaryMessage.h.

Member Typedef Documentation

typedef GroupSizeType BinarySize

Length of group data.

Definition at line 510 of file BinaryMessage.h.

typedef DimensionType Dimension

Aliases repeating group dimension type.

Definition at line 507 of file BinaryMessage.h.

typedef EntryType Entry

Aliases type of repeating group entry.

Definition at line 504 of file BinaryMessage.h.

typedef DimensionType::BlockLength EntrySize

Length of group entry data.

Definition at line 516 of file BinaryMessage.h.

typedef Dimension::NumInGroup Size

Size of group (number of entries).

Definition at line 523 of file BinaryMessage.h.

Constructor & Destructor Documentation

BinaryGroup ( )
inline

Initializes blank instance referencing to nothing.

Definition at line 702 of file BinaryMessage.h.

BinaryGroup ( const void *  data,
BinarySize  size,
SchemaVersion  version 
)
inline

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

Definition at line 713 of file BinaryMessage.h.

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

Initializes instance as a copy of the other one.

Definition at line 757 of file BinaryMessage.h.

Member Function Documentation

Iterator begin ( ) const
inline

Returns iterator pointing to the first repeating group entry.

Definition at line 794 of file BinaryMessage.h.

const void* binary ( ) const
inline

SBE-encoded data representing repeating group.

Definition at line 831 of file BinaryMessage.h.

BinarySize binarySize ( ) const
inline

Size of SBE-encoded data representing repeating group.

Definition at line 841 of file BinaryMessage.h.

bool empty ( ) const
inline

Indicates whether a repeating group being referenced is empty.

Definition at line 781 of file BinaryMessage.h.

Iterator end ( ) const
inline

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

Definition at line 804 of file BinaryMessage.h.

const void* entries ( ) const
inline

Location of repeating group entries.

Definition at line 847 of file BinaryMessage.h.

EntrySize entrySize ( ) const
inline

Size in bytes of single repeating group entry.

Definition at line 853 of file BinaryMessage.h.

operator bool ( ) const
inline

Indicates whether given instance refers to a valid repeating group.

Definition at line 774 of file BinaryMessage.h.

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

Re-initializes instance as copy of the other one.

Definition at line 860 of file BinaryMessage.h.

Entry operator[] ( Size  index) const
inline

Provides access to a repeating group entry by index. Index validness is not checked due to performance considerations.

Definition at line 817 of file BinaryMessage.h.

Size size ( ) const
inline

Returns number of entries in a repeating group being referenced.

Definition at line 788 of file BinaryMessage.h.


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