OnixS C++ CME MDP Premium Market Data Handler 5.10.2
Users' manual and API documentation
Loading...
Searching...
No Matches
IncrementalRefreshBook46::OrderIDEntry Struct Reference

#include <OnixS/CME/MDH/messaging/Messages.h>

Public Types

typedef SbeGroupEntry< GroupSize8Byte::BlockLengthBase
typedef OrderIDEntry ThisType
Public Types inherited from SbeGroupEntry< GroupSize8Byte::BlockLength >
typedef GroupSize8Byte::BlockLength BlockLength

Public Member Functions

 OrderIDEntry (void *data, EncodedLength length, SchemaVersion version)
ThisTyperesetVariableFields () noexcept
ThisTypereset () noexcept
UInt64 orderId () const noexcept
ThisTypesetOrderId (UInt64 value) noexcept
bool orderPriority (UInt64 &value) const noexcept
ThisTypesetOrderPriority (UInt64 value) noexcept
ThisTypeorderPriorityNull () noexcept
bool displayQty (Int32 &value) const noexcept
ThisTypesetDisplayQty (Int32 value) noexcept
ThisTypedisplayQtyNull () noexcept
bool referenceId (UInt8 &value) const noexcept
ThisTypesetReferenceId (UInt8 value) noexcept
ThisTypereferenceIdNull () noexcept
OrderUpdateAction::Enum orderUpdateAction () const noexcept
ThisTypesetOrderUpdateAction (OrderUpdateAction::Enum value) noexcept
Public Member Functions inherited from SbeGroupEntry< GroupSize8Byte::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
void zeroPaddingBytes (BlockLength offset) 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 BlockLength blockLength (SchemaVersion version) noexcept
static constexpr BlockLength minimalBlockLength (SchemaVersion version) noexcept
static constexpr StrRef className () noexcept

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>
Value ordinary (BlockLength offset, SchemaVersion since) const
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>
Decimal decimal (BlockLength offset) const
template<class NullValue>
bool decimal (Decimal &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
Protected Member Functions inherited from BinaryBlockBase
 ~BinaryBlockBase ()=default

Detailed Description

Number of OrderID entries. Entry of OrderIDEntry repeating group.

Definition at line 14989 of file Messages.h.

Member Typedef Documentation

◆ Base

Base class type.

Definition at line 15001 of file Messages.h.

◆ ThisType

This type alias.

Definition at line 15004 of file Messages.h.

Constructor & Destructor Documentation

◆ OrderIDEntry()

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

Initializes instance of given version over given memory block.

Definition at line 15008 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 15161 of file Messages.h.

◆ className()

constexpr StrRef className ( )
inlinestaticconstexprnoexcept

Entity class name.

Definition at line 15187 of file Messages.h.

◆ displayQty()

bool displayQty ( Int32 & value) const
inlinenoexcept

Visible qty of order.

Definition at line 15081 of file Messages.h.

◆ displayQtyNull()

ThisType & displayQtyNull ( )
inlinenoexcept

Definition at line 15097 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 15175 of file Messages.h.

◆ orderId()

UInt64 orderId ( ) const
inlinenoexcept

Unique Order ID.

Definition at line 15037 of file Messages.h.

◆ orderPriority()

bool orderPriority ( UInt64 & value) const
inlinenoexcept

Order priority for execution on the order book.

Definition at line 15055 of file Messages.h.

◆ orderPriorityNull()

ThisType & orderPriorityNull ( )
inlinenoexcept

Definition at line 15071 of file Messages.h.

◆ orderUpdateAction()

OrderUpdateAction::Enum orderUpdateAction ( ) const
inlinenoexcept

Order book update action to be applied to the order referenced by OrderID.

Definition at line 15136 of file Messages.h.

◆ referenceId()

bool referenceId ( UInt8 & value) const
inlinenoexcept

Reference to corresponding Price and Security ID, sequence of MD entry in the message.

Definition at line 15108 of file Messages.h.

◆ referenceIdNull()

ThisType & referenceIdNull ( )
inlinenoexcept

Definition at line 15125 of file Messages.h.

◆ reset()

ThisType & reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 15025 of file Messages.h.

◆ resetVariableFields()

ThisType & resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

Definition at line 15019 of file Messages.h.

◆ setDisplayQty()

ThisType & setDisplayQty ( Int32 value)
inlinenoexcept

Visible qty of order.

Definition at line 15089 of file Messages.h.

◆ setOrderId()

ThisType & setOrderId ( UInt64 value)
inlinenoexcept

Unique Order ID.

Definition at line 15045 of file Messages.h.

◆ setOrderPriority()

ThisType & setOrderPriority ( UInt64 value)
inlinenoexcept

Order priority for execution on the order book.

Definition at line 15063 of file Messages.h.

◆ setOrderUpdateAction()

ThisType & setOrderUpdateAction ( OrderUpdateAction::Enum value)
inlinenoexcept

Order book update action to be applied to the order referenced by OrderID.

Definition at line 15146 of file Messages.h.

◆ setReferenceId()

ThisType & setReferenceId ( UInt8 value)
inlinenoexcept

Reference to corresponding Price and Security ID, sequence of MD entry in the message.

Definition at line 15117 of file Messages.h.