OnixS C++ B3 Binary UMDF Market Data Handler  1.3.4
API documentation
Public Types | Public Member Functions | Friends | List of all members
SbeGroup< EntryType, DimensionType, GroupSizeType > Class Template Reference

#include <OnixS/B3/MarketData/UMDF/messaging/SbeMessage.h>

Public Types

enum  { EmptySize = Dimension::Size }
 
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 () throw ()
 
ONIXS_B3_UMDF_MD_HOTPATH SbeGroup (void *data, ONIXS_B3_UMDF_MD_UNUSED BinarySize size, SchemaVersion version) throw ()
 
bool valid () const throw ()
 
bool empty () const throw ()
 
ONIXS_B3_UMDF_MD_HOTPATH Size size () const throw ()
 
ONIXS_B3_UMDF_MD_HOTPATH Iterator begin () const throw ()
 
ONIXS_B3_UMDF_MD_HOTPATH Iterator end () const throw ()
 
ONIXS_B3_UMDF_MD_HOTPATH Entry operator[] (Size index) const
 
ONIXS_B3_UMDF_MD_NODISCARD Entries entries () const throw ()
 
const void * encoded () const throw ()
 
const void * tail () const throw ()
 
ONIXS_B3_UMDF_MD_HOTPATH void * binary () const throw ()
 
ONIXS_B3_UMDF_MD_HOTPATH BinarySize binarySize () const throw ()
 
ONIXS_B3_UMDF_MD_HOTPATH EntrySize entrySize () const throw ()
 

Friends

class SbeMessage
 

Detailed Description

template<class EntryType, class DimensionType, class GroupSizeType>
class OnixS::B3::MarketData::UMDF::Messaging::SbeGroup< EntryType, DimensionType, GroupSizeType >

Definition at line 630 of file SbeMessage.h.

Member Typedef Documentation

typedef GroupSizeType BinarySize

Length of group data.

Definition at line 637 of file SbeMessage.h.

typedef DimensionType Dimension

Repeating group dimension type.

Definition at line 634 of file SbeMessage.h.

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

Binary group blocks.

Definition at line 646 of file SbeMessage.h.

typedef Entries::Entry Entry

Group entry type.

Definition at line 652 of file SbeMessage.h.

typedef DimensionType::BlockLength EntrySize

Length of group entry data.

Definition at line 643 of file SbeMessage.h.

typedef Entries::Iterator Iterator

The iterator type for group entries.

Definition at line 649 of file SbeMessage.h.

typedef Entries::Size Size

Number of entries in the group.

Definition at line 655 of file SbeMessage.h.

Member Enumeration Documentation

anonymous enum

Length of an empty group.

Enumerator
EmptySize 

Definition at line 640 of file SbeMessage.h.

Constructor & Destructor Documentation

SbeGroup ( )
throw (
)
inline

Initializes a blank instance referencing to nothing.

Definition at line 658 of file SbeMessage.h.

ONIXS_B3_UMDF_MD_HOTPATH SbeGroup ( void *  data,
ONIXS_B3_UMDF_MD_UNUSED BinarySize  size,
SchemaVersion  version 
)
throw (
)
inline

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

Definition at line 668 of file SbeMessage.h.

Member Function Documentation

ONIXS_B3_UMDF_MD_HOTPATH Iterator begin ( ) const
throw (
)
inline
Returns
an iterator pointing to the first repeating group entry.

Definition at line 708 of file SbeMessage.h.

ONIXS_B3_UMDF_MD_HOTPATH void* binary ( ) const
throw (
)
inline
Returns
SBE-encoded data that represents the repeating group.

Definition at line 760 of file SbeMessage.h.

ONIXS_B3_UMDF_MD_HOTPATH BinarySize binarySize ( ) const
throw (
)
inline
Returns
the size of SBE-encoded data that represents the repeating group.

Definition at line 767 of file SbeMessage.h.

bool empty ( ) const
throw (
)
inline
Returns
true if the repeating group is empty, otherwise - false.

Definition at line 687 of file SbeMessage.h.

const void* encoded ( ) const
throw (
)
inline
Returns
SBE-encoded data that represents the repeating group.

Definition at line 747 of file SbeMessage.h.

ONIXS_B3_UMDF_MD_HOTPATH Iterator end ( ) const
throw (
)
inline
Returns
an iterator pointing to the entry behind the end of the group.

Definition at line 717 of file SbeMessage.h.

ONIXS_B3_UMDF_MD_NODISCARD Entries entries ( ) const
throw (
)
inline
Returns
Repeating group entries.

Definition at line 738 of file SbeMessage.h.

ONIXS_B3_UMDF_MD_HOTPATH EntrySize entrySize ( ) const
throw (
)
inline
Returns
the size of a single repeating group entry.

Definition at line 774 of file SbeMessage.h.

ONIXS_B3_UMDF_MD_HOTPATH 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 728 of file SbeMessage.h.

ONIXS_B3_UMDF_MD_HOTPATH Size size ( ) const
throw (
)
inline
Returns
the number of entries in the repeating group.

Definition at line 696 of file SbeMessage.h.

const void* tail ( ) const
throw (
)
inline
Returns
the end of SBE-encoded data that represents the repeating group.

Definition at line 753 of file SbeMessage.h.

bool valid ( ) const
throw (
)
inline
Returns
true if the instance refers to a valid repeating group, otherwise - false.

Definition at line 681 of file SbeMessage.h.

Friends And Related Function Documentation

friend class SbeMessage
friend

Definition at line 882 of file SbeMessage.h.

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