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

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

Public Member Functions

 ~SbeGroupDimensionOutput () ONIXS_FIXENGINE_DEFAULT
 
SbeFieldSetMetaData group () const
 
void set (SbeWireSize blockLength, SbeWireSize itemCount, SbeWireSize numGroups=UnusedWireSizeValue, SbeWireSize numVarDataFields=UnusedWireSizeValue)
 

Friends

SbeGroupDimensionOutput createSbeGroupDimensionOutput (void *)
 

Detailed Description

This class is used by the custom decoder to report the core decoder about parameters of the repeating group, before the decoding 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 759 of file SbeCustomization.h.

Constructor & Destructor Documentation

The destructor.

Member Function Documentation

SbeFieldSetMetaData group ( ) const

The group metadata for reference needs.

void set ( SbeWireSize  blockLength,
SbeWireSize  itemCount,
SbeWireSize  numGroups = UnusedWireSizeValue,
SbeWireSize  numVarDataFields = UnusedWireSizeValue 
)

Reports data about the repeating group.

Parameters
blockLengthThe length of the 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).

Friends And Related Function Documentation

SbeGroupDimensionOutput createSbeGroupDimensionOutput ( void *  )
friend

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