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

Public Types

enum  
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 (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 7836 of file Messages.h.

Member Typedef Documentation

◆ Schema

Used template schema.

Definition at line 7841 of file Messages.h.

◆ ThisType

This type alias.

Definition at line 7844 of file Messages.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId 105 

Definition at line 7847 of file Messages.h.

Constructor & Destructor Documentation

◆ OrderCancelRequest105() [1/6]

OrderCancelRequest105 ( )
default

Initializes a blank instance.

◆ OrderCancelRequest105() [2/6]

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

Initializes an instance over the given memory block.

Definition at line 7853 of file Messages.h.

◆ OrderCancelRequest105() [3/6]

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

◆ OrderCancelRequest105() [4/6]

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

Creates an instance over the given memory block.

Definition at line 7882 of file Messages.h.

◆ OrderCancelRequest105() [5/6]

OrderCancelRequest105 ( const SbeMessage & message)
inlineexplicit

Creates an instance over the given SBE message.

Definition at line 7893 of file Messages.h.

◆ OrderCancelRequest105() [6/6]

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

Creates an instance over the given memory block.

Performs no checks.

Definition at line 7904 of file Messages.h.

Member Function Documentation

◆ blockLength()

constexpr BlockLength blockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept

Size of message body in bytes.

Definition at line 8254 of file Messages.h.

◆ businessHeader() [1/2]

const InboundBusinessHeader & businessHeader ( ) const
inlinenoexcept

Message type = OrderCancelRequest.

Common header to all inbound business messages.

Definition at line 7931 of file Messages.h.

◆ businessHeader() [2/2]

InboundBusinessHeader & businessHeader ( )
inlinenoexcept

Common header to all inbound business messages.

Definition at line 7940 of file Messages.h.

◆ calculateBinarySize()

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

Definition at line 8345 of file Messages.h.

◆ className()

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

Definition at line 8314 of file Messages.h.

◆ clOrdId()

ClOrdID clOrdId ( ) const
inlinenoexcept

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

Definition at line 7950 of file Messages.h.

◆ deskId()

StrRef deskId ( ) const
inlinenoexcept

Identifies the trading desk.

Definition at line 8199 of file Messages.h.

◆ enteringTrader()

StrRef enteringTrader ( ) const
inlinenoexcept

Identifies the trader who is inserting an order.

Definition at line 8145 of file Messages.h.

◆ execRestatementReason()

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

Used to communicate a reason for a solicited cancel.

Definition at line 8091 of file Messages.h.

◆ executingTrader()

bool executingTrader ( StrRef & value) const
inlinenoexcept

Identifies the trader who is executing an order.

Definition at line 8167 of file Messages.h.

◆ fixType()

constexpr StrRef fixType ( )
inlinestaticconstexprnoexcept

FIX message type.

Definition at line 8323 of file Messages.h.

◆ getMaxMessageSize()

constexpr UInt64 getMaxMessageSize ( UInt8 )
inlinestaticconstexprnoexcept

Maximal message size.

Definition at line 8281 of file Messages.h.

◆ getMinimalVariableFieldsSize()

constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion version)
inlinestaticconstexpr

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

Definition at line 8269 of file Messages.h.

◆ memo()

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

◆ messageType()

constexpr MessageType::Enum messageType ( )
inlinestaticconstexprnoexcept

Message type = OrderCancelRequest.

Definition at line 7920 of file Messages.h.

◆ minimalBlockLength()

constexpr BlockLength minimalBlockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept

Minimal size of message body in bytes.

Definition at line 8240 of file Messages.h.

◆ orderId()

bool orderId ( OrderIDOptional & value) const
inlinenoexcept

Unique identifier for order as assigned by the exchange.

Definition at line 8012 of file Messages.h.

◆ origClOrdId()

bool origClOrdId ( ClOrdIDOptional & value) const
inlinenoexcept

ClOrdID which should be cancelled.

Definition at line 8041 of file Messages.h.

◆ reset()

ThisType & reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 8298 of file Messages.h.

◆ resetVariableFields()

ThisType & resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

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

◆ securityId()

SecurityID securityId ( ) const
inlinenoexcept

Security identification as defined by exchange.

Definition at line 7971 of file Messages.h.

◆ securityIdSource()

constexpr SecurityIDSource::Enum securityIdSource ( )
inlinestaticconstexprnoexcept

Identifies the class of the SecurityID (Exchange Symbol).

Definition at line 7992 of file Messages.h.

◆ senderLocation()

StrRef senderLocation ( ) const
inlinenoexcept

Identifies the original location for routing orders.

Definition at line 8123 of file Messages.h.

◆ setClOrdId()

ThisType & setClOrdId ( ClOrdID value)
inlinenoexcept

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

Definition at line 7960 of file Messages.h.

◆ setDeskId()

ThisType & setDeskId ( StrRef value)
inline

Identifies the trading desk.

Definition at line 8214 of file Messages.h.

◆ setEnteringTrader()

ThisType & setEnteringTrader ( StrRef value)
inlinenoexcept

Identifies the trader who is inserting an order.

Definition at line 8155 of file Messages.h.

◆ setExecRestatementReason()

ThisType & setExecRestatementReason ( ExecRestatementReasonValidForSingleCancel::Enum value)
inlinenoexcept

Used to communicate a reason for a solicited cancel.

Definition at line 8102 of file Messages.h.

◆ setExecRestatementReasonToNull()

ThisType & setExecRestatementReasonToNull ( )
inlinenoexcept

Definition at line 8112 of file Messages.h.

◆ setExecutingTrader()

ThisType & setExecutingTrader ( StrRef value)
inlinenoexcept

Identifies the trader who is executing an order.

Definition at line 8177 of file Messages.h.

◆ setExecutingTraderToNull()

ThisType & setExecutingTraderToNull ( )
inlinenoexcept

Definition at line 8187 of file Messages.h.

◆ setMemo()

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

◆ setOrderId()

ThisType & setOrderId ( OrderIDOptional value)
inlinenoexcept

Unique identifier for order as assigned by the exchange.

Definition at line 8021 of file Messages.h.

◆ setOrderIdToNull()

ThisType & setOrderIdToNull ( )
inlinenoexcept

Definition at line 8030 of file Messages.h.

◆ setOrigClOrdId()

ThisType & setOrigClOrdId ( ClOrdIDOptional value)
inlinenoexcept

ClOrdID which should be cancelled.

Definition at line 8050 of file Messages.h.

◆ setOrigClOrdIdToNull()

ThisType & setOrigClOrdIdToNull ( )
inlinenoexcept

Definition at line 8059 of file Messages.h.

◆ setSecurityId()

ThisType & setSecurityId ( SecurityID value)
inlinenoexcept

Security identification as defined by exchange.

Definition at line 7980 of file Messages.h.

◆ setSenderLocation()

ThisType & setSenderLocation ( StrRef value)
inlinenoexcept

Identifies the original location for routing orders.

Definition at line 8133 of file Messages.h.

◆ setSide()

ThisType & setSide ( Side::Enum value)
inlinenoexcept

Side of order.

Definition at line 8079 of file Messages.h.

◆ side()

Side::Enum side ( ) const
inlinenoexcept

Side of order.

Definition at line 8070 of file Messages.h.

◆ tail()

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

Definition at line 8335 of file Messages.h.

◆ toString()

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

Definition at line 801 of file MessageSerialization.h.