OnixS C++ FIX Engine  4.12.0
API Documentation
SbeGroupDimensionInput Class Reference

#include <OnixS/FIXEngine/FIX/SbeCustomization.h>

Public Member Functions

 ~SbeGroupDimensionInput () ONIXS_FIXENGINE_DEFAULT
 
SbeFieldSetMetaData groupMetaData () const
 
void getGroupDimensionData (SbeWireSize *blockLength=ONIXS_FIXENGINE_NULLPTR, size_t *itemCount=ONIXS_FIXENGINE_NULLPTR, SbeWireSize *numGroups=ONIXS_FIXENGINE_NULLPTR, SbeWireSize *numVarDataFields=ONIXS_FIXENGINE_NULLPTR) const
 

Protected Member Functions

 SbeGroupDimensionInput ()
 
 SbeGroupDimensionInput (const void *)
 

Protected Attributes

const void * details_
 

Friends

SbeGroupDimensionInput createSbeGroupDimensionInput (const void *)
 

Detailed Description

This class is used by the custom encoder to read parameters of the repeating group before the encoding of the repeating group itself.

Note
The class is copy-assignable and valid only during the appropriate callback of the custom decoder.

Definition at line 1006 of file SbeCustomization.h.

Constructor & Destructor Documentation

SbeGroupDimensionInput ( )
inlineprotected

Definition at line 1026 of file SbeCustomization.h.

SbeGroupDimensionInput ( const void *  )
protected

Member Function Documentation

void getGroupDimensionData ( SbeWireSize blockLength = ONIXS_FIXENGINE_NULLPTR,
size_t *  itemCount = ONIXS_FIXENGINE_NULLPTR,
SbeWireSize numGroups = ONIXS_FIXENGINE_NULLPTR,
SbeWireSize numVarDataFields = ONIXS_FIXENGINE_NULLPTR 
) const

Gets the group dimension data.

Parameters
blockLengthThe length of fixed-length part of the repeating group item.
itemCountThe number of items in the repeating group.
numGroupsThe number of nested groups of the given repeating group (optional).
numVarDataFieldsThe number of nested data fields of the given repeating group (optional).
SbeFieldSetMetaData groupMetaData ( ) const

The field set of the group which dimensions are reported via this object.

Friends And Related Function Documentation

SbeGroupDimensionInput createSbeGroupDimensionInput ( const void *  )
friend

Member Data Documentation

const void* details_
protected

Definition at line 1028 of file SbeCustomization.h.


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