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

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

Public Types

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

Public Member Functions

 OrderCancelRequest105 ()=default
 
 OrderCancelRequest105 (void *data, EncodedLength length, SchemaVersion version=Schema::Version)
 
 OrderCancelRequest105 (void *data, EncodedLength length, NoFieldsInit, SchemaVersion version=Schema::Version)
 
 OrderCancelRequest105 (void *data, EncodedLength length, NoInit)
 
 OrderCancelRequest105 (const SbeMessage &message)
 
 OrderCancelRequest105 (void *data, EncodedLength length, NoInit, NoCheck) noexcept
 
const InboundBusinessHeaderbusinessHeader () const noexcept
 
InboundBusinessHeaderbusinessHeader () noexcept
 
ClOrdID clOrdId () const noexcept
 
ThisTypesetClOrdId (ClOrdID value) noexcept
 
SecurityID securityId () const noexcept
 
ThisTypesetSecurityId (SecurityID value) noexcept
 
bool orderId (OrderIDOptional &value) const noexcept
 
ThisTypesetOrderId (OrderIDOptional value) noexcept
 
ThisTypesetOrderIdToNull () noexcept
 
bool origClOrdId (ClOrdIDOptional &value) const noexcept
 
ThisTypesetOrigClOrdId (ClOrdIDOptional value) noexcept
 
ThisTypesetOrigClOrdIdToNull () noexcept
 
Side::Enum side () const noexcept
 
ThisTypesetSide (Side::Enum value) noexcept
 
bool execRestatementReason (ExecRestatementReasonValidForSingleCancel::Enum &value) const noexcept
 
ThisTypesetExecRestatementReason (ExecRestatementReasonValidForSingleCancel::Enum value) noexcept
 
ThisTypesetExecRestatementReasonToNull () noexcept
 
StrRef senderLocation () const noexcept
 
ThisTypesetSenderLocation (StrRef value) noexcept
 
StrRef enteringTrader () const noexcept
 
ThisTypesetEnteringTrader (StrRef value) noexcept
 
bool executingTrader (StrRef &value) const noexcept
 
ThisTypesetExecutingTrader (StrRef value) noexcept
 
ThisTypesetExecutingTraderToNull () noexcept
 
StrRef deskId () const noexcept
 
StrRef memo () const noexcept
 
ThisTypesetDeskId (StrRef value)
 
ThisTypesetMemo (StrRef value)
 
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 7732 of file Messages.h.

Member Typedef Documentation

Used template schema.

Definition at line 7737 of file Messages.h.

This type alias.

Definition at line 7740 of file Messages.h.

Member Enumeration Documentation

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId 

Definition at line 7743 of file Messages.h.

Constructor & Destructor Documentation

OrderCancelRequest105 ( )
default

Initializes a blank instance.

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

Initializes an instance over the given memory block.

Definition at line 7749 of file Messages.h.

OrderCancelRequest105 ( 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 7764 of file Messages.h.

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

Creates an instance over the given memory block.

Definition at line 7778 of file Messages.h.

OrderCancelRequest105 ( const SbeMessage message)
inlineexplicit

Creates an instance over the given SBE message.

Definition at line 7789 of file Messages.h.

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

Creates an instance over the given memory block.

Performs no checks.

Definition at line 7800 of file Messages.h.

Member Function Documentation

static constexpr BlockLength blockLength ( SchemaVersion  version)
inlinestaticnoexcept

Size of message body in bytes.

Definition at line 8150 of file Messages.h.

const InboundBusinessHeader& businessHeader ( ) const
inlinenoexcept

Message type = OrderCancelRequest.

Common header to all inbound business messages.

Definition at line 7827 of file Messages.h.

InboundBusinessHeader& businessHeader ( )
inlinenoexcept

Common header to all inbound business messages.

Definition at line 7836 of file Messages.h.

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

Definition at line 8241 of file Messages.h.

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

Definition at line 8210 of file Messages.h.

ClOrdID clOrdId ( ) const
inlinenoexcept

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

Definition at line 7846 of file Messages.h.

StrRef deskId ( ) const
inlinenoexcept

Identifies the trading desk.

Definition at line 8095 of file Messages.h.

StrRef enteringTrader ( ) const
inlinenoexcept

Identifies the trader who is inserting an order.

Definition at line 8041 of file Messages.h.

bool execRestatementReason ( ExecRestatementReasonValidForSingleCancel::Enum value) const
inlinenoexcept

Used to communicate a reason for a solicited cancel.

Definition at line 7987 of file Messages.h.

bool executingTrader ( StrRef value) const
inlinenoexcept

Identifies the trader who is executing an order.

Definition at line 8063 of file Messages.h.

static constexpr StrRef fixType ( )
inlinestaticnoexcept

FIX message type.

Definition at line 8219 of file Messages.h.

static constexpr UInt64 getMaxMessageSize ( UInt8  )
inlinestaticnoexcept

Maximal message size.

Definition at line 8177 of file Messages.h.

static constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion  version)
inlinestatic

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

Definition at line 8165 of file Messages.h.

StrRef memo ( ) const
inlinenoexcept

Free ASCII format text field. This field may be used to convey client's relevant info. It's always echoed in the reports.

Definition at line 8103 of file Messages.h.

static constexpr MessageType::Enum messageType ( )
inlinestaticnoexcept

Message type = OrderCancelRequest.

Definition at line 7816 of file Messages.h.

static constexpr BlockLength minimalBlockLength ( SchemaVersion  version)
inlinestaticnoexcept

Minimal size of message body in bytes.

Definition at line 8136 of file Messages.h.

bool orderId ( OrderIDOptional value) const
inlinenoexcept

Unique identifier for order as assigned by the exchange.

Definition at line 7908 of file Messages.h.

bool origClOrdId ( ClOrdIDOptional value) const
inlinenoexcept

ClOrdID which should be canceled.

Definition at line 7937 of file Messages.h.

ThisType& reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 8194 of file Messages.h.

ThisType& resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

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

SecurityID securityId ( ) const
inlinenoexcept

Security identification as defined by exchange.

Definition at line 7867 of file Messages.h.

static constexpr SecurityIDSource::Enum securityIdSource ( )
inlinestaticnoexcept

Identifies the class of the SecurityID (Exchange Symbol).

Definition at line 7888 of file Messages.h.

StrRef senderLocation ( ) const
inlinenoexcept

Identifies the original location for routing orders.

Definition at line 8019 of file Messages.h.

ThisType& setClOrdId ( ClOrdID  value)
inlinenoexcept

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

Definition at line 7856 of file Messages.h.

ThisType& setDeskId ( StrRef  value)
inline

Identifies the trading desk.

Definition at line 8110 of file Messages.h.

ThisType& setEnteringTrader ( StrRef  value)
inlinenoexcept

Identifies the trader who is inserting an order.

Definition at line 8051 of file Messages.h.

ThisType& setExecRestatementReason ( ExecRestatementReasonValidForSingleCancel::Enum  value)
inlinenoexcept

Used to communicate a reason for a solicited cancel.

Definition at line 7998 of file Messages.h.

ThisType& setExecRestatementReasonToNull ( )
inlinenoexcept

Definition at line 8008 of file Messages.h.

ThisType& setExecutingTrader ( StrRef  value)
inlinenoexcept

Identifies the trader who is executing an order.

Definition at line 8073 of file Messages.h.

ThisType& setExecutingTraderToNull ( )
inlinenoexcept

Definition at line 8083 of file Messages.h.

ThisType& setMemo ( StrRef  value)
inline

Free ASCII format text field. This field may be used to convey client's relevant info. It's always echoed in the reports.

Definition at line 8121 of file Messages.h.

ThisType& setOrderId ( OrderIDOptional  value)
inlinenoexcept

Unique identifier for order as assigned by the exchange.

Definition at line 7917 of file Messages.h.

ThisType& setOrderIdToNull ( )
inlinenoexcept

Definition at line 7926 of file Messages.h.

ThisType& setOrigClOrdId ( ClOrdIDOptional  value)
inlinenoexcept

ClOrdID which should be canceled.

Definition at line 7946 of file Messages.h.

ThisType& setOrigClOrdIdToNull ( )
inlinenoexcept

Definition at line 7955 of file Messages.h.

ThisType& setSecurityId ( SecurityID  value)
inlinenoexcept

Security identification as defined by exchange.

Definition at line 7876 of file Messages.h.

ThisType& setSenderLocation ( StrRef  value)
inlinenoexcept

Identifies the original location for routing orders.

Definition at line 8029 of file Messages.h.

ThisType& setSide ( Side::Enum  value)
inlinenoexcept

Side of order.

Definition at line 7975 of file Messages.h.

Side::Enum side ( ) const
inlinenoexcept

Side of order.

Definition at line 7966 of file Messages.h.

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

Definition at line 8231 of file Messages.h.

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

Definition at line 801 of file MessageSerialization.h.


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