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

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

Public Types

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

Public Member Functions

 PositionMaintenanceCancelRequest501 ()=default
 
 PositionMaintenanceCancelRequest501 (void *data, EncodedLength length, SchemaVersion version=Schema::Version)
 
 PositionMaintenanceCancelRequest501 (void *data, EncodedLength length, NoFieldsInit, SchemaVersion version=Schema::Version)
 
 PositionMaintenanceCancelRequest501 (void *data, EncodedLength length, NoInit)
 
 PositionMaintenanceCancelRequest501 (const SbeMessage &message)
 
 PositionMaintenanceCancelRequest501 (void *data, EncodedLength length, NoInit, NoCheck) noexcept
 
const InboundBusinessHeaderbusinessHeader () const noexcept
 
InboundBusinessHeaderbusinessHeader () noexcept
 
PosReqID posReqId () const noexcept
 
ThisTypesetPosReqId (PosReqID value) noexcept
 
SecurityID securityId () const noexcept
 
ThisTypesetSecurityId (SecurityID value) noexcept
 
bool origPosReqRefId (PosReqIDOptional &value) const noexcept
 
ThisTypesetOrigPosReqRefId (PosReqIDOptional value) noexcept
 
ThisTypesetOrigPosReqRefIdToNull () noexcept
 
bool posMaintRptRefId (PosMaintRptIDOptional &value) const noexcept
 
ThisTypesetPosMaintRptRefId (PosMaintRptIDOptional value) noexcept
 
ThisTypesetPosMaintRptRefIdToNull () noexcept
 
StrRef senderLocation () const noexcept
 
ThisTypesetSenderLocation (StrRef value) noexcept
 
StrRef enteringTrader () const noexcept
 
ThisTypesetEnteringTrader (StrRef value) 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 21964 of file Messages.h.

Member Typedef Documentation

Used template schema.

Definition at line 21969 of file Messages.h.

This type alias.

Definition at line 21972 of file Messages.h.

Member Enumeration Documentation

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId 

Definition at line 21975 of file Messages.h.

Constructor & Destructor Documentation

Initializes a blank instance.

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

Initializes an instance over the given memory block.

Definition at line 21981 of file Messages.h.

PositionMaintenanceCancelRequest501 ( 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 21996 of file Messages.h.

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

Creates an instance over the given memory block.

Definition at line 22010 of file Messages.h.

PositionMaintenanceCancelRequest501 ( const SbeMessage message)
inlineexplicit

Creates an instance over the given SBE message.

Definition at line 22021 of file Messages.h.

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

Creates an instance over the given memory block.

Performs no checks.

Definition at line 22032 of file Messages.h.

Member Function Documentation

static constexpr BlockLength blockLength ( SchemaVersion  version)
inlinestaticnoexcept

Size of message body in bytes.

Definition at line 22263 of file Messages.h.

const InboundBusinessHeader& businessHeader ( ) const
inlinenoexcept

Message type = PositionMaintenanceCancelRequest.

Common header to all inbound business messages.

Definition at line 22059 of file Messages.h.

InboundBusinessHeader& businessHeader ( )
inlinenoexcept

Common header to all inbound business messages.

Definition at line 22068 of file Messages.h.

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

Definition at line 22354 of file Messages.h.

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

Definition at line 22319 of file Messages.h.

StrRef enteringTrader ( ) const
inlinenoexcept

Identifies the trader who is inserting an order.

Definition at line 22226 of file Messages.h.

static constexpr StrRef fixType ( )
inlinestaticnoexcept

FIX message type.

Definition at line 22328 of file Messages.h.

static constexpr UInt64 getMaxMessageSize ( UInt8  )
inlinestaticnoexcept

Maximal message size.

Definition at line 22289 of file Messages.h.

static constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion  version)
inlinestatic

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

Definition at line 22277 of file Messages.h.

static constexpr MessageType::Enum messageType ( )
inlinestaticnoexcept

Message type = PositionMaintenanceCancelRequest.

Definition at line 22048 of file Messages.h.

static constexpr BlockLength minimalBlockLength ( SchemaVersion  version)
inlinestaticnoexcept

Minimal size of message body in bytes.

Definition at line 22251 of file Messages.h.

bool origPosReqRefId ( PosReqIDOptional value) const
inlinenoexcept

Reference to the PosReqID (710) of a previous maintenance request that is being canceled.

Definition at line 22139 of file Messages.h.

bool posMaintRptRefId ( PosMaintRptIDOptional value) const
inlinenoexcept

Reference to a PosMaintRptID (721) from a previous Position Maintenance Report that is being canceled.

Definition at line 22171 of file Messages.h.

PosReqID posReqId ( ) const
inlinenoexcept

Unique identifier for the position maintenance request.

Definition at line 22077 of file Messages.h.

ThisType& reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 22305 of file Messages.h.

ThisType& resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

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

SecurityID securityId ( ) const
inlinenoexcept

Security identification as defined by exchange.

Definition at line 22097 of file Messages.h.

static constexpr SecurityIDSource::Enum securityIdSource ( )
inlinestaticnoexcept

Identifies the class of the SecurityID (Exchange Symbol).

Definition at line 22118 of file Messages.h.

StrRef senderLocation ( ) const
inlinenoexcept

Identifies the original location for routing orders.

Definition at line 22204 of file Messages.h.

ThisType& setEnteringTrader ( StrRef  value)
inlinenoexcept

Identifies the trader who is inserting an order.

Definition at line 22236 of file Messages.h.

ThisType& setOrigPosReqRefId ( PosReqIDOptional  value)
inlinenoexcept

Reference to the PosReqID (710) of a previous maintenance request that is being canceled.

Definition at line 22149 of file Messages.h.

ThisType& setOrigPosReqRefIdToNull ( )
inlinenoexcept

Definition at line 22158 of file Messages.h.

ThisType& setPosMaintRptRefId ( PosMaintRptIDOptional  value)
inlinenoexcept

Reference to a PosMaintRptID (721) from a previous Position Maintenance Report that is being canceled.

Definition at line 22183 of file Messages.h.

ThisType& setPosMaintRptRefIdToNull ( )
inlinenoexcept

Definition at line 22193 of file Messages.h.

ThisType& setPosReqId ( PosReqID  value)
inlinenoexcept

Unique identifier for the position maintenance request.

Definition at line 22086 of file Messages.h.

ThisType& setSecurityId ( SecurityID  value)
inlinenoexcept

Security identification as defined by exchange.

Definition at line 22106 of file Messages.h.

ThisType& setSenderLocation ( StrRef  value)
inlinenoexcept

Identifies the original location for routing orders.

Definition at line 22214 of file Messages.h.

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

Definition at line 22341 of file Messages.h.

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

Definition at line 1686 of file MessageSerialization.h.


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