OnixS C++ FIX Engine  4.11.0
API Documentation
SbeSpecialCompositeOutput Class Reference

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

Public Member Functions

 ~SbeSpecialCompositeOutput () ONIXS_FIXENGINE_DEFAULT
 
SbeTypeMetaData type () const
 
void setMessageHeader (SbeWireSize blockLength, unsigned templateId, UInt32 schemaId, unsigned schemaVersion, SbeWireSize numGroups=UnusedWireSizeValue, SbeWireSize numVarDataFields=UnusedWireSizeValue)
 

Friends

SbeSpecialCompositeOutput createSbeSpecialCompositeOutput (void *)
 

Detailed Description

That class is used by the custom decoder to report the content of composites that are never incorporated into FIX messages but must be used by the decoding process. For now there is a single only such composite: the message header composite.

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

Definition at line 788 of file SbeCustomization.h.

Constructor & Destructor Documentation

The destructor.

Member Function Documentation

void setMessageHeader ( SbeWireSize  blockLength,
unsigned  templateId,
UInt32  schemaId,
unsigned  schemaVersion,
SbeWireSize  numGroups = UnusedWireSizeValue,
SbeWireSize  numVarDataFields = UnusedWireSizeValue 
)

Reports data about the message from the message header.

Parameters
blockLengthThe length of fixed-length part of the repeating group item.
templateIdThe template Id of the message.
schemaIdThe identifier of the schema.
schemaVersionThe version of the message.
numGroupsThe number of nested groups of the given repeating group (optional).
numVarDataFieldsThe number of nested data fields of the given repeating group (optional).
SbeTypeMetaData type ( ) const

The composite metadata for reference needs.

Friends And Related Function Documentation

SbeSpecialCompositeOutput createSbeSpecialCompositeOutput ( void *  )
friend

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