OnixS C++ FIX Engine 4.13.0
API Documentation
Loading...
Searching...
No Matches
SbeGroupDimensionOutput Class Reference

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

◆ ~SbeGroupDimensionOutput()

The destructor.

Member Function Documentation

◆ group()

SbeFieldSetMetaData group ( ) const

The group metadata for reference needs.

◆ set()

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).

◆ createSbeGroupDimensionOutput

SbeGroupDimensionOutput createSbeGroupDimensionOutput ( void * )
friend