OnixS C++ CME iLink 3 Binary Order Entry Handler 1.18.9
API Documentation
Loading...
Searching...
No Matches
OrderMassStatusRequest530 Struct Reference

Public Types

enum  
typedef SchemaTraits Schema
typedef OrderMassStatusRequest530 ThisType
Public Types inherited from SbeMessage
typedef MessageSize EncodedLength
typedef MessageSize BlockLength

Public Member Functions

 OrderMassStatusRequest530 ()=default
 OrderMassStatusRequest530 (void *data, EncodedLength length, SchemaVersion version=Schema::Version)
 OrderMassStatusRequest530 (void *data, EncodedLength length, NoFieldsInit, SchemaVersion version=Schema::Version)
 OrderMassStatusRequest530 (void *data, EncodedLength length, NoInit)
 OrderMassStatusRequest530 (const SbeMessage &message)
 OrderMassStatusRequest530 (void *data, EncodedLength length, NoInit, NoCheck) noexcept
UInt64 partyDetailsListReqId () const noexcept
ThisTypesetPartyDetailsListReqId (UInt64 value) noexcept
UInt64 massStatusReqId () const noexcept
ThisTypesetMassStatusReqId (UInt64 value) noexcept
ManualOrdIndReq::Enum manualOrderIndicator () const noexcept
ThisTypesetManualOrderIndicator (ManualOrdIndReq::Enum value) noexcept
UInt32 seqNum () const noexcept
ThisTypesetSeqNum (UInt32 value) noexcept
StrRef senderId () const noexcept
ThisTypesetSenderId (StrRef value) noexcept
UInt64 sendingTimeEpoch () const noexcept
ThisTypesetSendingTimeEpoch (UInt64 value) noexcept
bool securityGroup (StrRef &value) const noexcept
ThisTypesetSecurityGroup (StrRef value) noexcept
ThisTypesetSecurityGroupToNull () noexcept
StrRef location () const noexcept
ThisTypesetLocation (StrRef value) noexcept
bool securityId (Int32 &value) const noexcept
ThisTypesetSecurityId (Int32 value) noexcept
ThisTypesetSecurityIdToNull () noexcept
MassStatusReqTyp::Enum massStatusReqType () const noexcept
ThisTypesetMassStatusReqType (MassStatusReqTyp::Enum value) noexcept
bool ordStatusReqType (MassStatusOrdTyp::Enum &value) const noexcept
ThisTypesetOrdStatusReqType (MassStatusOrdTyp::Enum value) noexcept
ThisTypesetOrdStatusReqTypeToNull () noexcept
bool timeInForce (MassStatusTIF::Enum &value) const noexcept
ThisTypesetTimeInForce (MassStatusTIF::Enum value) noexcept
ThisTypesetTimeInForceToNull () noexcept
bool marketSegmentId (UInt8 &value) const noexcept
ThisTypesetMarketSegmentId (UInt8 value) noexcept
ThisTypesetMarketSegmentIdToNull () noexcept
ThisTyperesetVariableFields () noexcept
ThisTypereset () noexcept
std::string toString () const
const void * tail () const noexcept
EncodedLength calculateBinarySize () const noexcept
Public Member Functions inherited from SbeMessage
 SbeMessage () noexcept
 SbeMessage (void *data, MessageSize size, SchemaVersion version)
 SbeMessage (void *data, MessageSize size)
 SbeMessage (void *data, MessageSize size, NoCheck) noexcept
void clear () noexcept
bool valid () const noexcept
MessageTemplateId templateId () const noexcept
SchemaVersion version () const noexcept
SchemaId schemaId () const noexcept
const void * binary () const noexcept
void * binary () noexcept
const void * blockEnd () noexcept
const void * blockEnd () const noexcept
MessageSize bufferSize () const noexcept
void * body () noexcept
BlockLength blockLength () const noexcept
const void * block () const noexcept
void * block () noexcept
Public Member Functions inherited from SbeFields< Messaging::SbeMessage, MessageSize >
Messaging::SbeMessagecontainer () noexcept
void zeroPaddingBytes (MessageSize offset) noexcept
void setOrdinary (MessageSize offset, FieldValue value) noexcept
void setEnumeration (MessageSize offset, typename Enumeration::Enum value) noexcept
void setFixedStr (MessageSize offset, StrRef value) noexcept

Static Public Member Functions

static constexpr BlockLength minimalBlockLength (SchemaVersion version) noexcept
static constexpr BlockLength blockLength (SchemaVersion version) noexcept
static constexpr MessageSize getMinimalVariableFieldsSize (SchemaVersion version)
static constexpr UInt64 getMaxMessageSize (UInt8) noexcept
static constexpr const CharclassName ()
static constexpr StrRef fixType () noexcept

Additional Inherited Members

Protected Types inherited from SbeMessage
typedef SbeGroupList< MessageSizeGroupList
typedef SbeVariableLengthFieldList< MessageSizeVariableLengthFieldList
Protected Member Functions inherited from SbeMessage
SbeMessageversion (SchemaVersion version) noexcept
GroupList groups () noexcept
GroupList groups () const noexcept
template<typename Group>
void initGroup (Group &group, typename Group::EntrySize entrySize) noexcept
template<typename Group>
void setupGroup (Group &group, typename Group::Size entryCount, const void *messageTail)
template<typename Group>
void constructGroup (Group &group, typename Group::Size entryCount, const void *messageTail)
void setVarDataField (DATA &data, StrRef value, const void *oldMessageTail)
VariableLengthFieldList variableLengthFields () noexcept
VariableLengthFieldList variableLengthFields () const noexcept
void init (MessageHeader::TemplateId value, MessageHeader::BlockLength minimalBlockLength, MessageHeader::BlockLength blockLength, SchemaId id) noexcept
MessageSize calculateBinarySize (const void *tail) const noexcept
template<class Callable, class Owner>
void setVariableLengthField (Callable callable, StrRef value, Owner &owner)
template<class Callable, class Owner>
void setVariableLengthField (Callable callable, StrRef value, SchemaVersion since, Owner &owner)
template<class Callable, class Owner>
StrRef getVariableLengthField (Callable callable, const Owner &owner) const noexcept
template<class Callable, class Owner>
StrRef getVariableLengthField (Callable callable, SchemaVersion since, Owner &owner) const noexcept
template<class Callable, class Owner>
void setVariableLengthFieldToNull (Callable callable, Owner &owner) noexcept
template<class Group, class Callable, class Owner>
void resetGroup (Callable callable, Owner &owner) noexcept
template<class Callable, class Owner>
void setVariableLengthFieldToNull (Callable callable, SchemaVersion since, Owner &owner) noexcept
template<class Group, class Callable, class Owner>
void resetGroup (Callable callable, SchemaVersion since, Owner &owner)
template<class Group, class Callable, class Owner>
Group getGroup (Callable callable, Owner &owner) const noexcept
template<class Group, class Callable, class Owner>
Group getGroup (Callable callable, SchemaVersion since, Owner &owner) const noexcept
template<class Group, class Callable, class Owner>
Group constructGroup (Callable callable, typename Group::Size length, SchemaVersion since, Owner &owner)
template<class Group, class Callable, class Owner>
Group constructGroup (Callable callable, typename Group::Size length, Owner &owner)
template<class Group, class Callable, class Owner>
Group setupGroup (Callable callable, typename Group::Size length, SchemaVersion since, Owner &owner)
template<class Group, class Callable, class Owner>
Group setupGroup (Callable callable, typename Group::Size length, Owner &owner)
Protected Member Functions inherited from SbeFields< Messaging::SbeMessage, MessageSize >
 SbeFields ()=default
 ~SbeFields ()=default
Protected Member Functions inherited from BinaryBlock< Messaging::SbeMessage, MessageSize >
 BinaryBlock ()=default
 ~BinaryBlock ()=default
Value ordinary (MessageSize offset) const noexcept
Enumeration::Enum enumeration (MessageSize offset) const noexcept
Value decimal (MessageSize offset) const noexcept
StrRef fixedStr (MessageSize offset) const noexcept
Static Protected Member Functions inherited from SbeMessage
static constexpr MessageSize getMaxMessageSize () noexcept

Detailed Description

Definition at line 23233 of file Messages.h.

Member Typedef Documentation

◆ Schema

Used template schema.

Definition at line 23238 of file Messages.h.

◆ ThisType

This type alias.

Definition at line 23241 of file Messages.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId 530 

Definition at line 23244 of file Messages.h.

Constructor & Destructor Documentation

◆ OrderMassStatusRequest530() [1/6]

Initializes a blank instance.

◆ OrderMassStatusRequest530() [2/6]

OrderMassStatusRequest530 ( void * data,
EncodedLength length,
SchemaVersion version = Schema::Version )
inline

Initializes an instance over the given memory block.

Definition at line 23250 of file Messages.h.

◆ OrderMassStatusRequest530() [3/6]

Initializes an instance over the given memory block With no variable-length fields initialization It is assumed that the user does such an initialization manually.

Definition at line 23265 of file Messages.h.

◆ OrderMassStatusRequest530() [4/6]

OrderMassStatusRequest530 ( void * data,
EncodedLength length,
NoInit  )
inline

Creates an instance over the given memory block.

Definition at line 23279 of file Messages.h.

◆ OrderMassStatusRequest530() [5/6]

OrderMassStatusRequest530 ( const SbeMessage & message)
inlineexplicit

Creates an instance over the given SBE message.

Definition at line 23290 of file Messages.h.

◆ OrderMassStatusRequest530() [6/6]

OrderMassStatusRequest530 ( void * data,
EncodedLength length,
NoInit ,
NoCheck  )
inlinenoexcept

Creates an instance over the given memory block.

Performs no checks.

Definition at line 23301 of file Messages.h.

Member Function Documentation

◆ blockLength()

constexpr BlockLength blockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept

Size of message body in bytes.

Definition at line 23731 of file Messages.h.

◆ calculateBinarySize()

EncodedLength calculateBinarySize ( ) const
inlinenoexcept
Returns
the size occupied by the message.

Definition at line 23824 of file Messages.h.

◆ className()

constexpr const Char * className ( )
inlinestaticconstexpr
Returns
class name.

Definition at line 23790 of file Messages.h.

◆ fixType()

constexpr StrRef fixType ( )
inlinestaticconstexprnoexcept

FIX message type.

Definition at line 23799 of file Messages.h.

◆ getMaxMessageSize()

constexpr UInt64 getMaxMessageSize ( UInt8 )
inlinestaticconstexprnoexcept

Maximal message size.

Definition at line 23757 of file Messages.h.

◆ getMinimalVariableFieldsSize()

constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion version)
inlinestaticconstexpr

Minimal variable fields size (when variable-length fields are empty).

Definition at line 23745 of file Messages.h.

◆ location()

StrRef location ( ) const
inlinenoexcept

Text describing sender's location (i.e.

geopraphic location and/or desk).

Definition at line 23503 of file Messages.h.

◆ manualOrderIndicator()

ManualOrdIndReq::Enum manualOrderIndicator ( ) const
inlinenoexcept

Indicates if the order was initially received manually (as opposed to electronically).

Definition at line 23363 of file Messages.h.

◆ marketSegmentId()

bool marketSegmentId ( UInt8 & value) const
inlinenoexcept

Conditionally required if OrderStatusRequestType=?Market Segment?

(Tag 585=100). Status for working orders belonging to this particular market segment will be returned. Will be ignored if present for any other criteria specified in OrderStatusRequestType besides market segment (Tag 585=100).

Definition at line 23682 of file Messages.h.

◆ massStatusReqId()

UInt64 massStatusReqId ( ) const
inlinenoexcept

Unique ID of OrderMassStatusRequest as assigned by the customer and present in Execution Report as well.

Definition at line 23341 of file Messages.h.

◆ massStatusReqType()

MassStatusReqTyp::Enum massStatusReqType ( ) const
inlinenoexcept

Specifies the scope of the OrderMassStatusRequest within the context of working orders only.

Status will be returned for all orders matching the criteria specified here for Session and Firm.

Definition at line 23568 of file Messages.h.

◆ minimalBlockLength()

constexpr BlockLength minimalBlockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept

Minimal size of message body in bytes.

Definition at line 23719 of file Messages.h.

◆ ordStatusReqType()

bool ordStatusReqType ( MassStatusOrdTyp::Enum & value) const
inlinenoexcept

If present ?

specifies the scope of the OrderMassStatusRequest within the context of MassStatusRequestType (585) and Session and Firm for working orders only. Status will be returned for all orders matching the criteria specified here for Session and Firm combination.

Definition at line 23599 of file Messages.h.

◆ partyDetailsListReqId()

UInt64 partyDetailsListReqId ( ) const
inlinenoexcept

Refers to the ID of the related PartyDetailsDefinitionRequest message which will logically be tied to this message.

Definition at line 23318 of file Messages.h.

◆ reset()

ThisType & reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 23773 of file Messages.h.

◆ resetVariableFields()

ThisType & resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

Definition at line 23766 of file Messages.h.

◆ securityGroup()

bool securityGroup ( StrRef & value) const
inlinenoexcept

Conditionally required if OrderStatusRequestType=?Product Group?

(Tag 585=3). Status for working orders belonging to this particular product group will be returned. Will be ignored if present for any other criteria specified in OrderStatusRequestType besides product group (Tag 585=3).

Definition at line 23466 of file Messages.h.

◆ securityId()

bool securityId ( Int32 & value) const
inlinenoexcept

Conditionally required if OrderStatusRequestType=?Instrument?

(Tag 585=1). Status for working orders belonging to this particular instrument will be returned. Will be ignored if present for any other criteria specified in OrderStatusRequestType besides Instrument.

Definition at line 23531 of file Messages.h.

◆ senderId()

StrRef senderId ( ) const
inlinenoexcept

Operator ID.

Should be unique per Firm ID. Assigned value used to identify specific message originator. Represents last individual or team in charge of the system which modifies the order before submission to the Globex platform, or if not modified from initiator (party role=118), last individual or team in charge of the system, which submit the order to the Globex platform.

Definition at line 23412 of file Messages.h.

◆ sendingTimeEpoch()

UInt64 sendingTimeEpoch ( ) const
inlinenoexcept

Time when the message is sent.

64-bit integer expressing the number of nano seconds since midnight January 1, 1970.

Definition at line 23441 of file Messages.h.

◆ seqNum()

UInt32 seqNum ( ) const
inlinenoexcept

Sequence number as assigned to message.

Definition at line 23386 of file Messages.h.

◆ setLocation()

ThisType & setLocation ( StrRef value)
inlinenoexcept

Text describing sender's location (i.e.

geopraphic location and/or desk).

Definition at line 23514 of file Messages.h.

◆ setManualOrderIndicator()

ThisType & setManualOrderIndicator ( ManualOrdIndReq::Enum value)
inlinenoexcept

Indicates if the order was initially received manually (as opposed to electronically).

Definition at line 23374 of file Messages.h.

◆ setMarketSegmentId()

ThisType & setMarketSegmentId ( UInt8 value)
inlinenoexcept

Conditionally required if OrderStatusRequestType=?Market Segment?

(Tag 585=100). Status for working orders belonging to this particular market segment will be returned. Will be ignored if present for any other criteria specified in OrderStatusRequestType besides market segment (Tag 585=100).

Definition at line 23696 of file Messages.h.

◆ setMarketSegmentIdToNull()

ThisType & setMarketSegmentIdToNull ( )
inlinenoexcept

Definition at line 23705 of file Messages.h.

◆ setMassStatusReqId()

ThisType & setMassStatusReqId ( UInt64 value)
inlinenoexcept

Unique ID of OrderMassStatusRequest as assigned by the customer and present in Execution Report as well.

Definition at line 23351 of file Messages.h.

◆ setMassStatusReqType()

ThisType & setMassStatusReqType ( MassStatusReqTyp::Enum value)
inlinenoexcept

Specifies the scope of the OrderMassStatusRequest within the context of working orders only.

Status will be returned for all orders matching the criteria specified here for Session and Firm.

Definition at line 23581 of file Messages.h.

◆ setOrdStatusReqType()

ThisType & setOrdStatusReqType ( MassStatusOrdTyp::Enum value)
inlinenoexcept

If present ?

specifies the scope of the OrderMassStatusRequest within the context of MassStatusRequestType (585) and Session and Firm for working orders only. Status will be returned for all orders matching the criteria specified here for Session and Firm combination.

Definition at line 23615 of file Messages.h.

◆ setOrdStatusReqTypeToNull()

ThisType & setOrdStatusReqTypeToNull ( )
inlinenoexcept

Definition at line 23625 of file Messages.h.

◆ setPartyDetailsListReqId()

ThisType & setPartyDetailsListReqId ( UInt64 value)
inlinenoexcept

Refers to the ID of the related PartyDetailsDefinitionRequest message which will logically be tied to this message.

Definition at line 23329 of file Messages.h.

◆ setSecurityGroup()

ThisType & setSecurityGroup ( StrRef value)
inlinenoexcept

Conditionally required if OrderStatusRequestType=?Product Group?

(Tag 585=3). Status for working orders belonging to this particular product group will be returned. Will be ignored if present for any other criteria specified in OrderStatusRequestType besides product group (Tag 585=3).

Definition at line 23480 of file Messages.h.

◆ setSecurityGroupToNull()

ThisType & setSecurityGroupToNull ( )
inlinenoexcept

Definition at line 23490 of file Messages.h.

◆ setSecurityId()

ThisType & setSecurityId ( Int32 value)
inlinenoexcept

Conditionally required if OrderStatusRequestType=?Instrument?

(Tag 585=1). Status for working orders belonging to this particular instrument will be returned. Will be ignored if present for any other criteria specified in OrderStatusRequestType besides Instrument.

Definition at line 23545 of file Messages.h.

◆ setSecurityIdToNull()

ThisType & setSecurityIdToNull ( )
inlinenoexcept

Definition at line 23554 of file Messages.h.

◆ setSenderId()

ThisType & setSenderId ( StrRef value)
inlinenoexcept

Operator ID.

Should be unique per Firm ID. Assigned value used to identify specific message originator. Represents last individual or team in charge of the system which modifies the order before submission to the Globex platform, or if not modified from initiator (party role=118), last individual or team in charge of the system, which submit the order to the Globex platform.

Definition at line 23428 of file Messages.h.

◆ setSendingTimeEpoch()

ThisType & setSendingTimeEpoch ( UInt64 value)
inlinenoexcept

Time when the message is sent.

64-bit integer expressing the number of nano seconds since midnight January 1, 1970.

Definition at line 23451 of file Messages.h.

◆ setSeqNum()

ThisType & setSeqNum ( UInt32 value)
inlinenoexcept

Sequence number as assigned to message.

Definition at line 23395 of file Messages.h.

◆ setTimeInForce()

ThisType & setTimeInForce ( MassStatusTIF::Enum value)
inlinenoexcept

Specifies the scope of the OrderMassStatusRequest within the context of MassStatusRequestType (585) if present.

Absence of this field is interpreted as Day & GTC & GTD. FAK is excluded since scope is limited to working orders only.

Definition at line 23656 of file Messages.h.

◆ setTimeInForceToNull()

ThisType & setTimeInForceToNull ( )
inlinenoexcept

Definition at line 23666 of file Messages.h.

◆ tail()

const void * tail ( ) const
inlinenoexcept
Returns
the end of the message.

Definition at line 23811 of file Messages.h.

◆ timeInForce()

bool timeInForce ( MassStatusTIF::Enum & value) const
inlinenoexcept

Specifies the scope of the OrderMassStatusRequest within the context of MassStatusRequestType (585) if present.

Absence of this field is interpreted as Day & GTC & GTD. FAK is excluded since scope is limited to working orders only.

Definition at line 23641 of file Messages.h.

◆ toString()

std::string toString ( ) const
inline
Returns
a human-readable presentation.

Definition at line 1794 of file MessageSerialization.h.