OnixS C++ B3 BOE Binary Order Entry  1.2.0
API Documentation
OrderMassActionRequest701 Struct Reference

#include <OnixS/B3/BOE/messaging/Messages.h>

Public Types

enum  { TemplateId = 701 }
 
typedef SchemaTraits Schema
 
typedef OrderMassActionRequest701 ThisType
 
- Public Types inherited from SbeMessage
typedef MessageSize EncodedLength
 
typedef MessageSize BlockLength
 

Public Member Functions

 OrderMassActionRequest701 ()=default
 
 OrderMassActionRequest701 (void *data, EncodedLength length, SchemaVersion version=Schema::Version)
 
 OrderMassActionRequest701 (void *data, EncodedLength length, NoFieldsInit, SchemaVersion version=Schema::Version)
 
 OrderMassActionRequest701 (void *data, EncodedLength length, NoInit)
 
 OrderMassActionRequest701 (const SbeMessage &message)
 
 OrderMassActionRequest701 (void *data, EncodedLength length, NoInit, NoCheck) noexcept
 
const InboundBusinessHeaderbusinessHeader () const noexcept
 
InboundBusinessHeaderbusinessHeader () noexcept
 
MassActionType::Enum massActionType () const noexcept
 
ThisTypesetMassActionType (MassActionType::Enum value) noexcept
 
bool massActionScope (MassActionScope::Enum &value) const noexcept
 
ThisTypesetMassActionScope (MassActionScope::Enum value) noexcept
 
ThisTypesetMassActionScopeToNull () noexcept
 
ClOrdID clOrdId () const noexcept
 
ThisTypesetClOrdId (ClOrdID value) noexcept
 
bool execRestatementReason (ExecRestatementReasonValidForMassCancel::Enum &value) const noexcept
 
ThisTypesetExecRestatementReason (ExecRestatementReasonValidForMassCancel::Enum value) noexcept
 
ThisTypesetExecRestatementReasonToNull () noexcept
 
bool ordTagId (OrdTagID &value) const noexcept
 
ThisTypesetOrdTagId (OrdTagID value) noexcept
 
ThisTypesetOrdTagIdToNull () noexcept
 
bool side (Side::Enum &value) const noexcept
 
ThisTypesetSide (Side::Enum value) noexcept
 
ThisTypesetSideToNull () noexcept
 
bool asset (StrRef &value) const noexcept
 
ThisTypesetAsset (StrRef value) noexcept
 
ThisTypesetAssetToNull () noexcept
 
bool securityId (SecurityIDOptional &value) const noexcept
 
ThisTypesetSecurityId (SecurityIDOptional value) noexcept
 
ThisTypesetSecurityIdToNull () noexcept
 
bool investorId (InvestorID &value) const noexcept
 
ThisTypesetInvestorId (InvestorID value) noexcept
 
ThisTypesetInvestorIdToNull () 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 (MessageSizeoffset) noexcept
 
void setOrdinary (MessageSizeoffset, FieldValue value) noexcept
 
void setOrdinary (MessageSizeoffset, FieldValue value, SchemaVersion since)
 
void setEnumeration (MessageSizeoffset, typename Enumeration::Enum value) noexcept
 
void setEnumeration (MessageSizeoffset, typename Enumeration::Enum value, SchemaVersion since)
 
void setFixedStr (MessageSizeoffset, StrRef value) noexcept
 
void setFixedStr (MessageSizeoffset, StrRef value, SchemaVersion since)
 

Static Public Member Functions

static constexpr MessageType::Enum messageType () noexcept
 
static constexpr SecurityIDSource::Enum securityIdSource () noexcept
 
static constexpr StrRef securityExchange () noexcept
 
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)
 
template<typename DATA >
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 (MessageSizeoffset) const noexcept
 
bool ordinary (Value &value, MessageSizeoffset, NullValue null) const noexcept
 
bool ordinary (Value &value, MessageSizeoffset, NullValue null, SchemaVersion since) const noexcept
 
const Value & accessOrdinary (MessageSizeoffset) const noexcept
 
Value & accessOrdinary (MessageSizeoffset) noexcept
 
Enumeration::Enum enumeration (MessageSizeoffset) const noexcept
 
bool enumeration (typename Enumeration::Enum &value, MessageSizeoffset, NullValue null) const noexcept
 
bool enumeration (typename Enumeration::Enum &value, MessageSizeoffset, NullValue null, SchemaVersion since) const noexcept
 
Value decimal (MessageSizeoffset) const noexcept
 
bool decimal (Value &value, MessageSizeoffset, NullValue null) const noexcept
 
bool decimal (Value &value, MessageSizeoffset, NullValue null, SchemaVersion since) const noexcept
 
StrRef fixedStr (MessageSizeoffset) const noexcept
 
bool fixedStr (StrRef &value, MessageSizeoffset) const noexcept
 
bool fixedStr (StrRef &value, MessageSizeoffset, SchemaVersion since) const noexcept
 
- Static Protected Member Functions inherited from SbeMessage
static constexpr MessageSize getMaxMessageSize () noexcept
 

Detailed Description

Definition at line 25346 of file Messages.h.

Member Typedef Documentation

Used template schema.

Definition at line 25351 of file Messages.h.

This type alias.

Definition at line 25354 of file Messages.h.

Member Enumeration Documentation

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId 

Definition at line 25357 of file Messages.h.

Constructor & Destructor Documentation

Initializes a blank instance.

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

Initializes an instance over the given memory block.

Definition at line 25363 of file Messages.h.

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

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 25378 of file Messages.h.

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

Creates an instance over the given memory block.

Definition at line 25392 of file Messages.h.

OrderMassActionRequest701 ( const SbeMessage message)
inlineexplicit

Creates an instance over the given SBE message.

Definition at line 25403 of file Messages.h.

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

Creates an instance over the given memory block.

Performs no checks.

Definition at line 25414 of file Messages.h.

Member Function Documentation

bool asset ( StrRef value) const
inlinenoexcept

Asset associated with the security, such as DOL, BGI, OZ1, WDL, CNI, etc.

Definition at line 25630 of file Messages.h.

static constexpr BlockLength blockLength ( SchemaVersion  version)
inlinestaticnoexcept

Size of message body in bytes.

Definition at line 25763 of file Messages.h.

const InboundBusinessHeader& businessHeader ( ) const
inlinenoexcept

Message type = OrderMassActionRequest.

Common header to all inbound business messages.

Definition at line 25441 of file Messages.h.

InboundBusinessHeader& businessHeader ( )
inlinenoexcept

Common header to all inbound business messages.

Definition at line 25450 of file Messages.h.

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

Definition at line 25860 of file Messages.h.

static constexpr const Char* className ( )
inlinestatic
Returns
class name.

Definition at line 25825 of file Messages.h.

ClOrdID clOrdId ( ) const
inlinenoexcept

Unique identifier of the order as assigned by the market participant.

Definition at line 25515 of file Messages.h.

bool execRestatementReason ( ExecRestatementReasonValidForMassCancel::Enum value) const
inlinenoexcept

Used to communicate event type which triggers the Order Mass Action Request.

Definition at line 25538 of file Messages.h.

static constexpr StrRef fixType ( )
inlinestaticnoexcept

FIX message type.

Definition at line 25834 of file Messages.h.

static constexpr UInt64 getMaxMessageSize ( UInt8  )
inlinestaticnoexcept

Maximal message size.

Definition at line 25790 of file Messages.h.

static constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion  version)
inlinestatic

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

Definition at line 25778 of file Messages.h.

bool investorId ( InvestorID value) const
inlinenoexcept

Unique identifier of investor for mass cancel on behalf purposes.

Definition at line 25716 of file Messages.h.

bool massActionScope ( MassActionScope::Enum value) const
inlinenoexcept

Specifies the scope of the action.

Definition at line 25482 of file Messages.h.

MassActionType::Enum massActionType ( ) const
inlinenoexcept

Specifies the type of action requested.

Definition at line 25459 of file Messages.h.

static constexpr MessageType::Enum messageType ( )
inlinestaticnoexcept

Message type = OrderMassActionRequest.

Definition at line 25430 of file Messages.h.

static constexpr BlockLength minimalBlockLength ( SchemaVersion  version)
inlinestaticnoexcept

Minimal size of message body in bytes.

Definition at line 25749 of file Messages.h.

bool ordTagId ( OrdTagID value) const
inlinenoexcept

Identifies the order tag identification.

Definition at line 25571 of file Messages.h.

ThisType& reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 25806 of file Messages.h.

ThisType& resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

Definition at line 25799 of file Messages.h.

static constexpr StrRef securityExchange ( )
inlinestaticnoexcept

Identifies the class of the SecurityID (Exchange Symbol).

Market to which the symbol belongs.

Definition at line 25707 of file Messages.h.

bool securityId ( SecurityIDOptional value) const
inlinenoexcept

Security identification as defined by exchange.

Definition at line 25664 of file Messages.h.

static constexpr SecurityIDSource::Enum securityIdSource ( )
inlinestaticnoexcept

Identifies the class of the SecurityID (Exchange Symbol).

Definition at line 25695 of file Messages.h.

ThisType& setAsset ( StrRef  value)
inlinenoexcept

Asset associated with the security, such as DOL, BGI, OZ1, WDL, CNI, etc.

Definition at line 25641 of file Messages.h.

ThisType& setAssetToNull ( )
inlinenoexcept

Definition at line 25651 of file Messages.h.

ThisType& setClOrdId ( ClOrdID  value)
inlinenoexcept

Unique identifier of the order as assigned by the market participant.

Definition at line 25525 of file Messages.h.

ThisType& setExecRestatementReason ( ExecRestatementReasonValidForMassCancel::Enum  value)
inlinenoexcept

Used to communicate event type which triggers the Order Mass Action Request.

Definition at line 25550 of file Messages.h.

ThisType& setExecRestatementReasonToNull ( )
inlinenoexcept

Definition at line 25560 of file Messages.h.

ThisType& setInvestorId ( InvestorID  value)
inlinenoexcept

Unique identifier of investor for mass cancel on behalf purposes.

Definition at line 25726 of file Messages.h.

ThisType& setInvestorIdToNull ( )
inlinenoexcept

Definition at line 25735 of file Messages.h.

ThisType& setMassActionScope ( MassActionScope::Enum  value)
inlinenoexcept

Specifies the scope of the action.

Definition at line 25493 of file Messages.h.

ThisType& setMassActionScopeToNull ( )
inlinenoexcept

Definition at line 25503 of file Messages.h.

ThisType& setMassActionType ( MassActionType::Enum  value)
inlinenoexcept

Specifies the type of action requested.

Definition at line 25469 of file Messages.h.

ThisType& setOrdTagId ( OrdTagID  value)
inlinenoexcept

Identifies the order tag identification.

Definition at line 25580 of file Messages.h.

ThisType& setOrdTagIdToNull ( )
inlinenoexcept

Definition at line 25589 of file Messages.h.

ThisType& setSecurityId ( SecurityIDOptional  value)
inlinenoexcept

Security identification as defined by exchange.

Definition at line 25674 of file Messages.h.

ThisType& setSecurityIdToNull ( )
inlinenoexcept

Definition at line 25683 of file Messages.h.

ThisType& setSide ( Side::Enum  value)
inlinenoexcept

Side of order.

Definition at line 25609 of file Messages.h.

ThisType& setSideToNull ( )
inlinenoexcept

Definition at line 25618 of file Messages.h.

bool side ( Side::Enum value) const
inlinenoexcept

Side of order.

Definition at line 25600 of file Messages.h.

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

Definition at line 25847 of file Messages.h.

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

Definition at line 1955 of file MessageSerialization.h.


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