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

Public Types

enum  
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 InboundBusinessHeader & businessHeader () const noexcept
InboundBusinessHeader & businessHeader () noexcept
PosReqID posReqId () const noexcept
ThisType & setPosReqId (PosReqID value) noexcept
SecurityID securityId () const noexcept
ThisType & setSecurityId (SecurityID value) noexcept
bool origPosReqRefId (PosReqIDOptional &value) const noexcept
ThisType & setOrigPosReqRefId (PosReqIDOptional value) noexcept
ThisType & setOrigPosReqRefIdToNull () noexcept
bool posMaintRptRefId (PosMaintRptIDOptional &value) const noexcept
ThisType & setPosMaintRptRefId (PosMaintRptIDOptional value) noexcept
ThisType & setPosMaintRptRefIdToNull () noexcept
StrRef senderLocation () const noexcept
ThisType & setSenderLocation (StrRef value) noexcept
StrRef enteringTrader () const noexcept
ThisType & setEnteringTrader (StrRef value) noexcept
ThisType & resetVariableFields () noexcept
ThisType & reset () 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::SbeMessage & container () 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 Char * className ()
static constexpr StrRef fixType () noexcept

Additional Inherited Members

Protected Types inherited from SbeMessage
typedef SbeGroupList< MessageSize > GroupList
typedef SbeVariableLengthFieldList< MessageSize > VariableLengthFieldList
Protected Member Functions inherited from SbeMessage
SbeMessage & version (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 22406 of file Messages.h.

Member Typedef Documentation

◆ Schema

typedef SchemaTraits Schema

Used template schema.

Definition at line 22411 of file Messages.h.

◆ ThisType

typedef PositionMaintenanceCancelRequest501 ThisType

This type alias.

Definition at line 22414 of file Messages.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId 501 

Definition at line 22417 of file Messages.h.

Constructor & Destructor Documentation

◆ PositionMaintenanceCancelRequest501() [1/6]

PositionMaintenanceCancelRequest501 ( )
default

Initializes a blank instance.

◆ PositionMaintenanceCancelRequest501() [2/6]

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

Initializes an instance over the given memory block.

Definition at line 22423 of file Messages.h.

◆ PositionMaintenanceCancelRequest501() [3/6]

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

◆ PositionMaintenanceCancelRequest501() [4/6]

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

Creates an instance over the given memory block.

Definition at line 22452 of file Messages.h.

◆ PositionMaintenanceCancelRequest501() [5/6]

PositionMaintenanceCancelRequest501 ( const SbeMessage & message)
inlineexplicit

Creates an instance over the given SBE message.

Definition at line 22463 of file Messages.h.

◆ PositionMaintenanceCancelRequest501() [6/6]

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

Creates an instance over the given memory block.

Performs no checks.

Definition at line 22474 of file Messages.h.

Member Function Documentation

◆ blockLength()

constexpr BlockLength blockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept

Size of message body in bytes.

Definition at line 22705 of file Messages.h.

◆ businessHeader() [1/2]

const InboundBusinessHeader & businessHeader ( ) const
inlinenoexcept

Message type = PositionMaintenanceCancelRequest.

Common header to all inbound business messages.

Definition at line 22501 of file Messages.h.

◆ businessHeader() [2/2]

InboundBusinessHeader & businessHeader ( )
inlinenoexcept

Common header to all inbound business messages.

Definition at line 22510 of file Messages.h.

◆ calculateBinarySize()

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

Definition at line 22796 of file Messages.h.

◆ className()

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

Definition at line 22761 of file Messages.h.

◆ enteringTrader()

StrRef enteringTrader ( ) const
inlinenoexcept

Identifies the trader who is inserting an order.

Definition at line 22668 of file Messages.h.

◆ fixType()

constexpr StrRef fixType ( )
inlinestaticconstexprnoexcept

FIX message type.

Definition at line 22770 of file Messages.h.

◆ getMaxMessageSize()

constexpr UInt64 getMaxMessageSize ( UInt8 )
inlinestaticconstexprnoexcept

Maximal message size.

Definition at line 22731 of file Messages.h.

◆ getMinimalVariableFieldsSize()

constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion version)
inlinestaticconstexpr

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

Definition at line 22719 of file Messages.h.

◆ messageType()

constexpr MessageType::Enum messageType ( )
inlinestaticconstexprnoexcept

Message type = PositionMaintenanceCancelRequest.

Definition at line 22490 of file Messages.h.

◆ minimalBlockLength()

constexpr BlockLength minimalBlockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept

Minimal size of message body in bytes.

Definition at line 22693 of file Messages.h.

◆ origPosReqRefId()

bool origPosReqRefId ( PosReqIDOptional & value) const
inlinenoexcept

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

Definition at line 22581 of file Messages.h.

◆ posMaintRptRefId()

bool posMaintRptRefId ( PosMaintRptIDOptional & value) const
inlinenoexcept

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

Definition at line 22613 of file Messages.h.

◆ posReqId()

PosReqID posReqId ( ) const
inlinenoexcept

Unique identifier for the position maintenance request.

Definition at line 22519 of file Messages.h.

◆ reset()

ThisType & reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 22747 of file Messages.h.

◆ resetVariableFields()

ThisType & resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

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

◆ securityId()

SecurityID securityId ( ) const
inlinenoexcept

Security identification as defined by exchange.

Definition at line 22539 of file Messages.h.

◆ securityIdSource()

constexpr SecurityIDSource::Enum securityIdSource ( )
inlinestaticconstexprnoexcept

Identifies the class of the SecurityID (Exchange Symbol).

Definition at line 22560 of file Messages.h.

◆ senderLocation()

StrRef senderLocation ( ) const
inlinenoexcept

Identifies the original location for routing orders.

Definition at line 22646 of file Messages.h.

◆ setEnteringTrader()

ThisType & setEnteringTrader ( StrRef value)
inlinenoexcept

Identifies the trader who is inserting an order.

Definition at line 22678 of file Messages.h.

◆ setOrigPosReqRefId()

ThisType & setOrigPosReqRefId ( PosReqIDOptional value)
inlinenoexcept

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

Definition at line 22591 of file Messages.h.

◆ setOrigPosReqRefIdToNull()

ThisType & setOrigPosReqRefIdToNull ( )
inlinenoexcept

Definition at line 22600 of file Messages.h.

◆ setPosMaintRptRefId()

ThisType & setPosMaintRptRefId ( PosMaintRptIDOptional value)
inlinenoexcept

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

Definition at line 22625 of file Messages.h.

◆ setPosMaintRptRefIdToNull()

ThisType & setPosMaintRptRefIdToNull ( )
inlinenoexcept

Definition at line 22635 of file Messages.h.

◆ setPosReqId()

ThisType & setPosReqId ( PosReqID value)
inlinenoexcept

Unique identifier for the position maintenance request.

Definition at line 22528 of file Messages.h.

◆ setSecurityId()

ThisType & setSecurityId ( SecurityID value)
inlinenoexcept

Security identification as defined by exchange.

Definition at line 22548 of file Messages.h.

◆ setSenderLocation()

ThisType & setSenderLocation ( StrRef value)
inlinenoexcept

Identifies the original location for routing orders.

Definition at line 22656 of file Messages.h.

◆ tail()

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

Definition at line 22783 of file Messages.h.

◆ toString()

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

Definition at line 1686 of file MessageSerialization.h.