OnixS C++ B3 BOE Binary Order Entry 1.3.0
API Documentation
Loading...
Searching...
No Matches
OrderMassActionRequest701 Struct Reference

Public Types

enum  
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 (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 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 (MessageSize offset) const noexcept
const Value & accessOrdinary (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 25776 of file Messages.h.

Member Typedef Documentation

◆ Schema

Used template schema.

Definition at line 25781 of file Messages.h.

◆ ThisType

This type alias.

Definition at line 25784 of file Messages.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId 701 

Definition at line 25787 of file Messages.h.

Constructor & Destructor Documentation

◆ OrderMassActionRequest701() [1/6]

Initializes a blank instance.

◆ OrderMassActionRequest701() [2/6]

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

Initializes an instance over the given memory block.

Definition at line 25793 of file Messages.h.

◆ OrderMassActionRequest701() [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 25808 of file Messages.h.

◆ OrderMassActionRequest701() [4/6]

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

Creates an instance over the given memory block.

Definition at line 25822 of file Messages.h.

◆ OrderMassActionRequest701() [5/6]

OrderMassActionRequest701 ( const SbeMessage & message)
inlineexplicit

Creates an instance over the given SBE message.

Definition at line 25833 of file Messages.h.

◆ OrderMassActionRequest701() [6/6]

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

Creates an instance over the given memory block.

Performs no checks.

Definition at line 25844 of file Messages.h.

Member Function Documentation

◆ asset()

bool asset ( StrRef & value) const
inlinenoexcept

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

Definition at line 26060 of file Messages.h.

◆ blockLength()

constexpr BlockLength blockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept

Size of message body in bytes.

Definition at line 26193 of file Messages.h.

◆ businessHeader() [1/2]

const InboundBusinessHeader & businessHeader ( ) const
inlinenoexcept

Message type = OrderMassActionRequest.

Common header to all inbound business messages.

Definition at line 25871 of file Messages.h.

◆ businessHeader() [2/2]

InboundBusinessHeader & businessHeader ( )
inlinenoexcept

Common header to all inbound business messages.

Definition at line 25880 of file Messages.h.

◆ calculateBinarySize()

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

Definition at line 26290 of file Messages.h.

◆ className()

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

Definition at line 26255 of file Messages.h.

◆ clOrdId()

ClOrdID clOrdId ( ) const
inlinenoexcept

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

Definition at line 25945 of file Messages.h.

◆ execRestatementReason()

bool execRestatementReason ( ExecRestatementReasonValidForMassCancel::Enum & value) const
inlinenoexcept

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

Definition at line 25968 of file Messages.h.

◆ fixType()

constexpr StrRef fixType ( )
inlinestaticconstexprnoexcept

FIX message type.

Definition at line 26264 of file Messages.h.

◆ getMaxMessageSize()

constexpr UInt64 getMaxMessageSize ( UInt8 )
inlinestaticconstexprnoexcept

Maximal message size.

Definition at line 26220 of file Messages.h.

◆ getMinimalVariableFieldsSize()

constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion version)
inlinestaticconstexpr

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

Definition at line 26208 of file Messages.h.

◆ investorId()

bool investorId ( InvestorID & value) const
inlinenoexcept

Unique identifier of investor for mass cancel on behalf purposes.

Definition at line 26146 of file Messages.h.

◆ massActionScope()

bool massActionScope ( MassActionScope::Enum & value) const
inlinenoexcept

Specifies the scope of the action.

Definition at line 25912 of file Messages.h.

◆ massActionType()

MassActionType::Enum massActionType ( ) const
inlinenoexcept

Specifies the type of action requested.

Definition at line 25889 of file Messages.h.

◆ messageType()

constexpr MessageType::Enum messageType ( )
inlinestaticconstexprnoexcept

Message type = OrderMassActionRequest.

Definition at line 25860 of file Messages.h.

◆ minimalBlockLength()

constexpr BlockLength minimalBlockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept

Minimal size of message body in bytes.

Definition at line 26179 of file Messages.h.

◆ ordTagId()

bool ordTagId ( OrdTagID & value) const
inlinenoexcept

Identifies the order tag identification.

Definition at line 26001 of file Messages.h.

◆ reset()

ThisType & reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 26236 of file Messages.h.

◆ resetVariableFields()

ThisType & resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

Definition at line 26229 of file Messages.h.

◆ securityExchange()

constexpr StrRef securityExchange ( )
inlinestaticconstexprnoexcept

Identifies the class of the SecurityID (Exchange Symbol).

Market to which the symbol belongs.

Definition at line 26137 of file Messages.h.

◆ securityId()

bool securityId ( SecurityIDOptional & value) const
inlinenoexcept

Security identification as defined by exchange.

Definition at line 26094 of file Messages.h.

◆ securityIdSource()

constexpr SecurityIDSource::Enum securityIdSource ( )
inlinestaticconstexprnoexcept

Identifies the class of the SecurityID (Exchange Symbol).

Definition at line 26125 of file Messages.h.

◆ setAsset()

ThisType & setAsset ( StrRef value)
inlinenoexcept

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

Definition at line 26071 of file Messages.h.

◆ setAssetToNull()

ThisType & setAssetToNull ( )
inlinenoexcept

Definition at line 26081 of file Messages.h.

◆ setClOrdId()

ThisType & setClOrdId ( ClOrdID value)
inlinenoexcept

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

Definition at line 25955 of file Messages.h.

◆ setExecRestatementReason()

ThisType & setExecRestatementReason ( ExecRestatementReasonValidForMassCancel::Enum value)
inlinenoexcept

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

Definition at line 25980 of file Messages.h.

◆ setExecRestatementReasonToNull()

ThisType & setExecRestatementReasonToNull ( )
inlinenoexcept

Definition at line 25990 of file Messages.h.

◆ setInvestorId()

ThisType & setInvestorId ( InvestorID value)
inlinenoexcept

Unique identifier of investor for mass cancel on behalf purposes.

Definition at line 26156 of file Messages.h.

◆ setInvestorIdToNull()

ThisType & setInvestorIdToNull ( )
inlinenoexcept

Definition at line 26165 of file Messages.h.

◆ setMassActionScope()

ThisType & setMassActionScope ( MassActionScope::Enum value)
inlinenoexcept

Specifies the scope of the action.

Definition at line 25923 of file Messages.h.

◆ setMassActionScopeToNull()

ThisType & setMassActionScopeToNull ( )
inlinenoexcept

Definition at line 25933 of file Messages.h.

◆ setMassActionType()

ThisType & setMassActionType ( MassActionType::Enum value)
inlinenoexcept

Specifies the type of action requested.

Definition at line 25899 of file Messages.h.

◆ setOrdTagId()

ThisType & setOrdTagId ( OrdTagID value)
inlinenoexcept

Identifies the order tag identification.

Definition at line 26010 of file Messages.h.

◆ setOrdTagIdToNull()

ThisType & setOrdTagIdToNull ( )
inlinenoexcept

Definition at line 26019 of file Messages.h.

◆ setSecurityId()

ThisType & setSecurityId ( SecurityIDOptional value)
inlinenoexcept

Security identification as defined by exchange.

Definition at line 26104 of file Messages.h.

◆ setSecurityIdToNull()

ThisType & setSecurityIdToNull ( )
inlinenoexcept

Definition at line 26113 of file Messages.h.

◆ setSide()

ThisType & setSide ( Side::Enum value)
inlinenoexcept

Side of order.

Definition at line 26039 of file Messages.h.

◆ setSideToNull()

ThisType & setSideToNull ( )
inlinenoexcept

Definition at line 26048 of file Messages.h.

◆ side()

bool side ( Side::Enum & value) const
inlinenoexcept

Side of order.

Definition at line 26030 of file Messages.h.

◆ tail()

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

Definition at line 26277 of file Messages.h.

◆ toString()

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

Definition at line 1955 of file MessageSerialization.h.