SbeSpecialCompositeInput Class Reference

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

Public Member Functions
	~SbeSpecialCompositeInput () ONIXS_FIXENGINE_DEFAULT
SbeTypeMetaData	typeMetaData () const
void	getMessageHeaderData (UInt32 *blockLength=ONIXS_FIXENGINE_NULLPTR, UInt32 *templateId=ONIXS_FIXENGINE_NULLPTR, UInt32 *schemaId=ONIXS_FIXENGINE_NULLPTR, UInt32 *schemaVersion=ONIXS_FIXENGINE_NULLPTR, UInt32 *numOfGroups=ONIXS_FIXENGINE_NULLPTR, UInt32 *numOfVarDataFields=ONIXS_FIXENGINE_NULLPTR) const

Protected Member Functions
	SbeSpecialCompositeInput ()
	SbeSpecialCompositeInput (const void *)

Protected Attributes
const void *	details_

Friends
SbeSpecialCompositeInput	createSbeSpecialCompositeInput (const void *)

Detailed Description

That class is used by custom encoders to get the content for composites that are never incorporated into FIX messages but must be used by the encoding 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 968 of file SbeCustomization.h.

Constructor & Destructor Documentation

~SbeSpecialCompositeInput

(

)

SbeSpecialCompositeInput ( )

inlineprotected

Definition at line 996 of file SbeCustomization.h.

SbeSpecialCompositeInput ( const void *  )

protected

Member Function Documentation

void getMessageHeaderData	(	UInt32 *	blockLength = ONIXS_FIXENGINE_NULLPTR,
		UInt32 *	templateId = ONIXS_FIXENGINE_NULLPTR,
		UInt32 *	schemaId = ONIXS_FIXENGINE_NULLPTR,
		UInt32 *	schemaVersion = ONIXS_FIXENGINE_NULLPTR,
		UInt32 *	numOfGroups = ONIXS_FIXENGINE_NULLPTR,
		UInt32 *	numOfVarDataFields = ONIXS_FIXENGINE_NULLPTR
	)		const

Gets the message header data.

Requests all or particular data for the SBE message header. The data is provided in its most common form, as unsigned 32-bits integer values that is too wide for most of message headers. Thus the obtained values can (and usually - should) be converted by the encoder to other data types, for example, to the UInt16.

Parameters

blockLength	The length of the 'root segment' of the message.
templateId	The required template Id to encode.
schemaId	The schema Id.
schemaVersion	The version of the template to use for the subsequent FIX message.
numOfGroups	The number of groups in the top-level field set of the message.
numOfVarDataFields	The number of <data> fields in the top-level field set of the message.

SbeTypeMetaData typeMetaData

(

)

const

Metadata of the composite which data are reported via this object.

Friends And Related Function Documentation

SbeSpecialCompositeInput createSbeSpecialCompositeInput ( const void *  )

friend

Member Data Documentation

const void* details_

protected

Definition at line 998 of file SbeCustomization.h.

---

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

• OnixS/FIXEngine/FIX/SbeCustomization.h