OnixS C++ CME MDP Conflated TCP Handler 1.3.6
API Documentation
Loading...
Searching...
No Matches
InstrumentDefinitionOption55::UnderlyingsEntry Struct Reference

Public Types

typedef SbeGroupEntry< GroupSize::BlockLength > Base
typedef UnderlyingsEntry ThisType
Public Types inherited from SbeGroupEntry< GroupSize::BlockLength >
typedef GroupSize::BlockLength BlockLength

Public Member Functions

 UnderlyingsEntry (void *data, EncodedLength length, SchemaVersion version)
ThisType & resetVariableFields () noexcept
ThisType & reset () noexcept
Int32 underlyingSecurityId () const noexcept
ThisType & setUnderlyingSecurityId (Int32 value) noexcept
StrRef underlyingSymbol () const noexcept
ThisType & setUnderlyingSymbol (StrRef value) noexcept
Public Member Functions inherited from SbeGroupEntry< GroupSize::BlockLength >
 SbeGroupEntry ()
 SbeGroupEntry (void *encoded, BlockLength size, SchemaVersion version)
bool valid () const noexcept
const void * encoded () const noexcept
void * encoded () noexcept
const void * block () const noexcept
void * block () noexcept
BlockLength blockLength () const noexcept
SchemaVersion version () const noexcept
Public Member Functions inherited from SbeFields< Container, BlockLength >
Container & container () noexcept
template<class FieldValue>
void setOrdinary (BlockLength offset, FieldValue value) noexcept
template<class FieldValue>
void setOrdinary (BlockLength offset, FieldValue value, SchemaVersion since)
template<class Enumeration>
void setEnumeration (BlockLength offset, typename Enumeration::Enum value) noexcept
template<class Enumeration>
void setEnumeration (BlockLength offset, typename Enumeration::Enum value, SchemaVersion since)
template<BlockLength Size>
void setFixedStr (BlockLength offset, StrRef value) noexcept
template<BlockLength Size>
void setFixedStr (BlockLength offset, StrRef value, SchemaVersion since)

Static Public Member Functions

static constexpr SecurityIDSource underlyingSecurityIdSource () noexcept
static constexpr BlockLength blockLength (SchemaVersion version) noexcept
static constexpr BlockLength minimalBlockLength (SchemaVersion version) noexcept
static constexpr const Char * className ()

Additional Inherited Members

Protected Member Functions inherited from SbeFields< Container, BlockLength >
 SbeFields ()=default
 ~SbeFields ()=default
Protected Member Functions inherited from BinaryBlock< Container, BlockLength >
 BinaryBlock ()=default
 ~BinaryBlock ()=default
template<class Value>
Value ordinary (BlockLength offset) const noexcept
template<class Value, class NullValue>
bool ordinary (Value &value, BlockLength offset, NullValue null) const noexcept
template<class Value, class NullValue>
bool ordinary (Value &value, BlockLength offset, NullValue null, SchemaVersion since) const noexcept
template<class Enumeration>
Enumeration::Enum enumeration (BlockLength offset) const noexcept
template<class Enumeration, class NullValue>
bool enumeration (typename Enumeration::Enum &value, BlockLength offset, NullValue null) const noexcept
template<class Enumeration, class NullValue>
bool enumeration (typename Enumeration::Enum &value, BlockLength offset, NullValue null, SchemaVersion since) const noexcept
template<class Value>
Value decimal (BlockLength offset) const noexcept
template<class Value, class NullValue>
bool decimal (Value &value, BlockLength offset, NullValue null) const noexcept
template<class Value, class NullValue>
bool decimal (Value &value, BlockLength offset, NullValue null, SchemaVersion since) const noexcept
template<BlockLength Length>
StrRef fixedStr (BlockLength offset) const noexcept
template<BlockLength Length>
bool fixedStr (StrRef &value, BlockLength offset) const noexcept
template<BlockLength Length>
bool fixedStr (StrRef &value, BlockLength offset, SchemaVersion since) const noexcept

Detailed Description

Entry of UnderlyingsEntry repeating group.

Definition at line 28959 of file Messages.h.

Member Typedef Documentation

◆ Base

typedef SbeGroupEntry< GroupSize::BlockLength > Base

Base class type.

Definition at line 28971 of file Messages.h.

◆ ThisType

typedef UnderlyingsEntry ThisType

This type alias.

Definition at line 28974 of file Messages.h.

Constructor & Destructor Documentation

◆ UnderlyingsEntry()

UnderlyingsEntry ( void * data,
EncodedLength length,
SchemaVersion version )
inline

Initializes instance of given version over given memory block.

Definition at line 28978 of file Messages.h.

Member Function Documentation

◆ blockLength()

constexpr BlockLength blockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept
Returns
size of entry body in bytes for given version of message template.

Definition at line 29060 of file Messages.h.

◆ className()

constexpr const Char * className ( )
inlinestaticconstexpr

Entity class name.

Definition at line 29087 of file Messages.h.

◆ minimalBlockLength()

constexpr BlockLength minimalBlockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept
Returns
minimal size of entry body in bytes for given version of message template.

Definition at line 29074 of file Messages.h.

◆ reset()

ThisType & reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 28996 of file Messages.h.

◆ resetVariableFields()

ThisType & resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

Definition at line 28989 of file Messages.h.

◆ setUnderlyingSecurityId()

ThisType & setUnderlyingSecurityId ( Int32 value)
inlinenoexcept

Unique Instrument ID as qualified by the exchange per tag 305-UnderlyingSecurityIDSource.

Definition at line 29016 of file Messages.h.

◆ setUnderlyingSymbol()

ThisType & setUnderlyingSymbol ( StrRef value)
inlinenoexcept

Underlying Instrument Symbol (Contract Name).

Definition at line 29046 of file Messages.h.

◆ underlyingSecurityId()

Int32 underlyingSecurityId ( ) const
inlinenoexcept

Unique Instrument ID as qualified by the exchange per tag 305-UnderlyingSecurityIDSource.

Definition at line 29006 of file Messages.h.

◆ underlyingSecurityIdSource()

constexpr SecurityIDSource underlyingSecurityIdSource ( )
inlinestaticconstexprnoexcept

This value is always '8' for CME.

Definition at line 29028 of file Messages.h.

◆ underlyingSymbol()

StrRef underlyingSymbol ( ) const
inlinenoexcept

Underlying Instrument Symbol (Contract Name).

Definition at line 29036 of file Messages.h.