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

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

Public Types

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

Public Member Functions

 PositionMaintenanceRequest502 ()=default
 
 PositionMaintenanceRequest502 (void *data, EncodedLength length, SchemaVersion version=Schema::Version)
 
 PositionMaintenanceRequest502 (void *data, EncodedLength length, NoFieldsInit, SchemaVersion version=Schema::Version)
 
 PositionMaintenanceRequest502 (void *data, EncodedLength length, NoInit)
 
 PositionMaintenanceRequest502 (const SbeMessage &message)
 
 PositionMaintenanceRequest502 (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 thresholdAmount (PriceOffsetOptional &value) const noexcept
 
ThisTypesetThresholdAmount (PriceOffsetOptional value) noexcept
 
ThisTypesetThresholdAmountToNull () noexcept
 
bool account (AccountOptional &value) const noexcept
 
ThisTypesetAccount (AccountOptional value) noexcept
 
ThisTypesetAccountToNull () noexcept
 
StrRef senderLocation () const noexcept
 
ThisTypesetSenderLocation (StrRef value) noexcept
 
PosTransType::Enum posTransType () const noexcept
 
ThisTypesetPosTransType (PosTransType::Enum value) noexcept
 
Timestamp clearingBusinessDate () const noexcept
 
ThisTypesetClearingBusinessDate (Timestamp value) noexcept
 
Boolean::Enum contraryInstructionIndicator () const noexcept
 
ThisTypesetContraryInstructionIndicator (Boolean::Enum value) noexcept
 
StrRef enteringTrader () const noexcept
 
ThisTypesetEnteringTrader (StrRef value) noexcept
 
Quantity longQty () const noexcept
 
ThisTypesetLongQty (Quantity value) 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 PosType::Enum posType () 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 22384 of file Messages.h.

Member Typedef Documentation

Used template schema.

Definition at line 22389 of file Messages.h.

This type alias.

Definition at line 22392 of file Messages.h.

Member Enumeration Documentation

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId 

Definition at line 22395 of file Messages.h.

Constructor & Destructor Documentation

Initializes a blank instance.

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

Initializes an instance over the given memory block.

Definition at line 22401 of file Messages.h.

PositionMaintenanceRequest502 ( 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 22416 of file Messages.h.

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

Creates an instance over the given memory block.

Definition at line 22430 of file Messages.h.

PositionMaintenanceRequest502 ( const SbeMessage message)
inlineexplicit

Creates an instance over the given SBE message.

Definition at line 22441 of file Messages.h.

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

Creates an instance over the given memory block.

Performs no checks.

Definition at line 22452 of file Messages.h.

Member Function Documentation

bool account ( AccountOptional value) const
inlinenoexcept

Account mnemonic of the order.

Definition at line 22593 of file Messages.h.

static constexpr BlockLength blockLength ( SchemaVersion  version)
inlinestaticnoexcept

Size of message body in bytes.

Definition at line 22824 of file Messages.h.

const InboundBusinessHeader& businessHeader ( ) const
inlinenoexcept

Message type = PositionMaintenanceRequest.

Common header to all inbound business messages.

Definition at line 22479 of file Messages.h.

InboundBusinessHeader& businessHeader ( )
inlinenoexcept

Common header to all inbound business messages.

Definition at line 22488 of file Messages.h.

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

Definition at line 22913 of file Messages.h.

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

Definition at line 22881 of file Messages.h.

Timestamp clearingBusinessDate ( ) const
inlinenoexcept

The 'Clearing Business Date' referred to by this request.

It must be set with the current date.

Definition at line 22665 of file Messages.h.

Boolean::Enum contraryInstructionIndicator ( ) const
inlinenoexcept

Used to indicate when a contrary instruction for exercise or abandonment is being submitted: The exercise should not happen to an ITM position or it should happen to an ATM or OTM position, always using the values of tags 709-PosTransType and 712-PosMaintAction to determine which operation will take place.

Should not be submitted when false.

Definition at line 22692 of file Messages.h.

StrRef deskId ( ) const
inlinenoexcept

Identifies the trading desk.

Definition at line 22771 of file Messages.h.

StrRef enteringTrader ( ) const
inlinenoexcept

Identifies the trader who is inserting an order.

Definition at line 22718 of file Messages.h.

static constexpr StrRef fixType ( )
inlinestaticnoexcept

FIX message type.

Definition at line 22890 of file Messages.h.

static constexpr UInt64 getMaxMessageSize ( UInt8  )
inlinestaticnoexcept

Maximal message size.

Definition at line 22850 of file Messages.h.

static constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion  version)
inlinestatic

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

Definition at line 22838 of file Messages.h.

Quantity longQty ( ) const
inlinenoexcept

Used to identify the type of quantity.

Long quantity.

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

static constexpr MessageType::Enum messageType ( )
inlinestaticnoexcept

Message type = PositionMaintenanceRequest.

Definition at line 22468 of file Messages.h.

static constexpr BlockLength minimalBlockLength ( SchemaVersion  version)
inlinestaticnoexcept

Minimal size of message body in bytes.

Definition at line 22812 of file Messages.h.

PosReqID posReqId ( ) const
inlinenoexcept

Unique identifier for the position maintenance request.

Definition at line 22497 of file Messages.h.

PosTransType::Enum posTransType ( ) const
inlinenoexcept

Identifies the type of position transaction.

Definition at line 22644 of file Messages.h.

static constexpr PosType::Enum posType ( )
inlinestaticnoexcept

Used to identify the type of quantity.

Definition at line 22741 of file Messages.h.

ThisType& reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 22867 of file Messages.h.

ThisType& resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

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

SecurityID securityId ( ) const
inlinenoexcept

Security identification as defined by exchange.

Definition at line 22517 of file Messages.h.

static constexpr SecurityIDSource::Enum securityIdSource ( )
inlinestaticnoexcept

Identifies the class of the SecurityID (Exchange Symbol).

Definition at line 22538 of file Messages.h.

StrRef senderLocation ( ) const
inlinenoexcept

Identifies the original location for routing orders.

Definition at line 22622 of file Messages.h.

ThisType& setAccount ( AccountOptional  value)
inlinenoexcept

Account mnemonic of the order.

Definition at line 22602 of file Messages.h.

ThisType& setAccountToNull ( )
inlinenoexcept

Definition at line 22611 of file Messages.h.

ThisType& setClearingBusinessDate ( Timestamp  value)
inlinenoexcept

The 'Clearing Business Date' referred to by this request.

It must be set with the current date.

Definition at line 22675 of file Messages.h.

ThisType& setContraryInstructionIndicator ( Boolean::Enum  value)
inlinenoexcept

Used to indicate when a contrary instruction for exercise or abandonment is being submitted: The exercise should not happen to an ITM position or it should happen to an ATM or OTM position, always using the values of tags 709-PosTransType and 712-PosMaintAction to determine which operation will take place.

Should not be submitted when false.

Definition at line 22707 of file Messages.h.

ThisType& setDeskId ( StrRef  value)
inline

Identifies the trading desk.

Definition at line 22786 of file Messages.h.

ThisType& setEnteringTrader ( StrRef  value)
inlinenoexcept

Identifies the trader who is inserting an order.

Definition at line 22728 of file Messages.h.

ThisType& setLongQty ( Quantity  value)
inlinenoexcept

Long quantity.

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

ThisType& setPosReqId ( PosReqID  value)
inlinenoexcept

Unique identifier for the position maintenance request.

Definition at line 22506 of file Messages.h.

ThisType& setPosTransType ( PosTransType::Enum  value)
inlinenoexcept

Identifies the type of position transaction.

Definition at line 22653 of file Messages.h.

ThisType& setSecurityId ( SecurityID  value)
inlinenoexcept

Security identification as defined by exchange.

Definition at line 22526 of file Messages.h.

ThisType& setSenderLocation ( StrRef  value)
inlinenoexcept

Identifies the original location for routing orders.

Definition at line 22632 of file Messages.h.

ThisType& setThresholdAmount ( PriceOffsetOptional  value)
inlinenoexcept

Used to indicate the minimum acceptable offset between the Strike Price and the Market Price.

Definition at line 22572 of file Messages.h.

ThisType& setThresholdAmountToNull ( )
inlinenoexcept

Definition at line 22582 of file Messages.h.

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

Definition at line 22903 of file Messages.h.

bool thresholdAmount ( PriceOffsetOptional value) const
inlinenoexcept

Used to indicate the minimum acceptable offset between the Strike Price and the Market Price.

Definition at line 22560 of file Messages.h.

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

Definition at line 1733 of file MessageSerialization.h.


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