SbeTypeMetaData Class Reference

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

Public Member Functions
const std::string &	name () const override
const std::string &	description () const override
bool	hasSchema () const override
SbeSchemaMetaData	schema () const override
unsigned	sinceVersion () const
bool	isSet () const
bool	isEnumeration () const
bool	isComposite () const
bool	isSimple () const
bool	isArray () const
SbePrimitiveType::Enum	primitiveType () const
SbeWireSize	fixedSize () const
SbeWireSize	arraySize () const
SbeWireSize	localOffset () const
SbePresence::Enum	presence () const
const std::string &	nullValue () const
const std::string &	minValue () const
const std::string &	maxValue () const
const std::string &	constValue () const
SbeFixSemanticType::Enum	semanticType () const
const std::string &	rawSemanticType () const
const std::string &	timeEpoch () const
const std::string &	timeUnit () const
size_t	noOfMembers () const
SbeTypeMetaData	member (size_t) const
size_t	noOfValues () const
SbeNamedValueMetaData	value (size_t) const
Public Member Functions inherited from ISbeNameDescription
virtual	~ISbeNameDescription ()=default

Friends
SbeTypeMetaData	createSbeTypeMetaData (const void *)

Detailed Description

Definition at line 279 of file SbeCustomization.h.

Member Function Documentation

arraySize()

SbeWireSize arraySize

(

)

const

The length of the fixed-length array.

constValue()

const std::string & constValue

(

)

const

The constant value (if applicable).

Returns

The constant value if it applicable to the type; an empty string otherwise.

description()

const std::string & description ( ) const

overridevirtual

The description of the type.

Implements ISbeNameDescription.

fixedSize()

SbeWireSize fixedSize

(

)

const

The size of the type.

Returns

0 if the type is a variadic-length type or fixed size of the type in bytes.

hasSchema()

bool hasSchema ( ) const

overridevirtual

Return true for most of such objects.

Implements ISchemaMember.

isArray()

bool isArray

(

)

const

Checks if the object describes an SBE array.

isComposite()

bool isComposite

(

)

const

Checks if the object describes an SBE composite.

isEnumeration()

bool isEnumeration

(

)

const

Checks if the object describes an SBE enumeration.

isSet()

bool isSet

(

)

const

Checks if the object describes an SBE set.

isSimple()

bool isSimple

(

)

const

Checks if the object describes a simple SBE type.

The simple type is a type that consists of a single field. This differs it against composites, arrays or field sets.

localOffset()

SbeWireSize localOffset

(

)

const

The local offset of the object.

maxValue()

const std::string & maxValue

(

)

const

The maximum value (if applicable).

Returns

The maximum possible value if it applicable to the type; an empty string otherwise.

member()

SbeTypeMetaData member

(

size_t

)

const

The metadata of the particular composite member.

minValue()

const std::string & minValue

(

)

const

The minimum value (if applicable).

Returns

The minimum possible value if it applicable to the type; an empty string otherwise.

name()

const std::string & name ( ) const

overridevirtual

The name of the type.

Implements ISbeNameDescription.

noOfMembers()

size_t noOfMembers

(

)

const

The number of composite type members.

noOfValues()

size_t noOfValues

(

)

const

The number of values for the multivalue type.

nullValue()

const std::string & nullValue

(

)

const

The null value (if applicable).

Returns

The null value if it applicable to the type; an empty string otherwise.

presence()

SbePresence::Enum presence

(

)

const

The presence of the type.

primitiveType()

SbePrimitiveType::Enum primitiveType

(

)

const

Primitive type that is used by the given type.

rawSemanticType()

const std::string & rawSemanticType

(

)

const

The string presentation of the FIX semantic type.

schema()

SbeSchemaMetaData schema ( ) const

overridevirtual

The schema metadata.

Implements ISchemaMember.

semanticType()

SbeFixSemanticType::Enum semanticType

(

)

const

The FIX semantic type of the type if applicable.

sinceVersion()

unsigned sinceVersion

(

)

const

The earliest version of the scheme where the type appears.

timeEpoch()

const std::string & timeEpoch

(

)

const

The epoch for the time-aware type.

timeUnit()

const std::string & timeUnit

(

)

const

The time unit for the time-aware type.

value()

SbeNamedValueMetaData value

(

size_t

)

const

The metadata of the particular value.

Friends And Related Symbol Documentation

createSbeTypeMetaData

SbeTypeMetaData createSbeTypeMetaData ( const void * )

friend