OnixS C++ CME iLink 3 Binary Order Entry Handler  1.17.0
API Documentation
OrderMassActionReport562::AffectedOrdersEntry Struct Reference

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

Public Types

typedef SbeGroupEntry< GroupSize::BlockLengthBase
 
typedef AffectedOrdersEntry ThisType
 
- Public Types inherited from SbeGroupEntry< GroupSize::BlockLength >
typedef GroupSize::BlockLength BlockLength
 

Public Member Functions

 AffectedOrdersEntry (void *data, EncodedLength length, SchemaVersion version)
 
ThisTyperesetVariableFields () noexcept
 
ThisTypereset () noexcept
 
StrRef origCIOrdId () const noexcept
 
ThisTypesetOrigCIOrdId (StrRef value) noexcept
 
UInt64 affectedOrderId () const noexcept
 
ThisTypesetAffectedOrderId (UInt64 value) noexcept
 
UInt32 cxlQuantity () const noexcept
 
ThisTypesetCxlQuantity (UInt32 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< SbeGroupEntry< GroupSize::BlockLength >, GroupSize::BlockLength >
SbeGroupEntry< GroupSize::BlockLength > & container () noexcept
 
void zeroPaddingBytes (GroupSize::BlockLengthoffset) noexcept
 
void setOrdinary (GroupSize::BlockLengthoffset, FieldValue value) noexcept
 
void setOrdinary (GroupSize::BlockLengthoffset, FieldValue value, SchemaVersion since)
 
void setEnumeration (GroupSize::BlockLengthoffset, typename Enumeration::Enum value) noexcept
 
void setEnumeration (GroupSize::BlockLengthoffset, typename Enumeration::Enum value, SchemaVersion since)
 
void setFixedStr (GroupSize::BlockLengthoffset, StrRef value) noexcept
 
void setFixedStr (GroupSize::BlockLengthoffset, StrRef value, SchemaVersion since)
 

Static Public Member Functions

static constexpr BlockLength blockLength (SchemaVersion version) noexcept
 
static constexpr BlockLength minimalBlockLength (SchemaVersion version) noexcept
 
static constexpr const CharclassName ()
 

Additional Inherited Members

- Protected Member Functions inherited from SbeFields< SbeGroupEntry< GroupSize::BlockLength >, GroupSize::BlockLength >
 SbeFields ()=default
 
 ~SbeFields ()=default
 
- Protected Member Functions inherited from BinaryBlock< SbeGroupEntry< GroupSize::BlockLength >, GroupSize::BlockLength >
 BinaryBlock ()=default
 
 ~BinaryBlock ()=default
 
Value ordinary (GroupSize::BlockLengthoffset) const noexcept
 
bool ordinary (Value &value, GroupSize::BlockLengthoffset, NullValue null) const noexcept
 
bool ordinary (Value &value, GroupSize::BlockLengthoffset, NullValue null, SchemaVersion since) const noexcept
 
Enumeration::Enum enumeration (GroupSize::BlockLengthoffset) const noexcept
 
bool enumeration (typename Enumeration::Enum &value, GroupSize::BlockLengthoffset, NullValue null) const noexcept
 
bool enumeration (typename Enumeration::Enum &value, GroupSize::BlockLengthoffset, NullValue null, SchemaVersion since) const noexcept
 
Value decimal (GroupSize::BlockLengthoffset) const noexcept
 
bool decimal (Value &value, GroupSize::BlockLengthoffset, NullValue null) const noexcept
 
bool decimal (Value &value, GroupSize::BlockLengthoffset, NullValue null, SchemaVersion since) const noexcept
 
StrRef fixedStr (GroupSize::BlockLengthoffset) const noexcept
 
bool fixedStr (StrRef &value, GroupSize::BlockLengthoffset) const noexcept
 
bool fixedStr (StrRef &value, GroupSize::BlockLengthoffset, SchemaVersion since) const noexcept
 

Detailed Description

Only used if orders could actually be cancelled otherwise will be set to zero. Must be followed by OrigCIOrdID. Entry of AffectedOrdersEntry repeating group.

Definition at line 44205 of file Messages.h.

Member Typedef Documentation

Base class type.

Definition at line 44217 of file Messages.h.

This type alias.

Definition at line 44220 of file Messages.h.

Constructor & Destructor Documentation

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

Initializes instance of given version over given memory block.

Definition at line 44224 of file Messages.h.

Member Function Documentation

UInt64 affectedOrderId ( ) const
inlinenoexcept

Order ID of an order cancelled by a mass action request.

Definition at line 44273 of file Messages.h.

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

Definition at line 44315 of file Messages.h.

static constexpr const Char* className ( )
inlinestatic

Entity class name.

Definition at line 44342 of file Messages.h.

UInt32 cxlQuantity ( ) const
inlinenoexcept

Total quantity cancelled for this order.

Definition at line 44293 of file Messages.h.

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

Definition at line 44329 of file Messages.h.

StrRef origCIOrdId ( ) const
inlinenoexcept

Contains the ClOrd of the cancelled order.

Definition at line 44251 of file Messages.h.

ThisType& reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 44242 of file Messages.h.

ThisType& resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

Definition at line 44235 of file Messages.h.

ThisType& setAffectedOrderId ( UInt64  value)
inlinenoexcept

Order ID of an order cancelled by a mass action request.

Definition at line 44282 of file Messages.h.

ThisType& setCxlQuantity ( UInt32  value)
inlinenoexcept

Total quantity cancelled for this order.

Definition at line 44302 of file Messages.h.

ThisType& setOrigCIOrdId ( StrRef  value)
inlinenoexcept

Contains the ClOrd of the cancelled order.

Definition at line 44261 of file Messages.h.


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