SbeGroupDimensionInput Class Reference

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

~SbeGroupDimensionInput

(

)

SbeGroupDimensionInput() [1/2]

SbeGroupDimensionInput ( )

inlineprotected

Definition at line 1026 of file SbeCustomization.h.

SbeGroupDimensionInput() [2/2]

SbeGroupDimensionInput ( const void * )

protected

Member Function Documentation

getGroupDimensionData()

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

blockLength	The length of fixed-length part of the repeating group item.
itemCount	The number of items in the repeating group.
numGroups	The number of nested groups of the given repeating group (optional).
numVarDataFields	The number of nested data fields of the given repeating group (optional).

groupMetaData()

SbeFieldSetMetaData groupMetaData

(

)

const

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

Friends And Related Symbol Documentation

createSbeGroupDimensionInput

SbeGroupDimensionInput createSbeGroupDimensionInput ( const void * )

friend

Member Data Documentation

details_

const void* details_

protected

Definition at line 1028 of file SbeCustomization.h.