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

Classes

struct  PositionsEntry

Public Types

enum  
typedef SchemaTraits Schema
typedef PositionMaintenanceReport503 ThisType
typedef SbeGroup< PositionsEntry, GroupSizeEncoding, MessageSizePositions
Public Types inherited from SbeMessage
typedef MessageSize EncodedLength
typedef MessageSize BlockLength

Public Member Functions

 PositionMaintenanceReport503 ()=default
 PositionMaintenanceReport503 (void *data, EncodedLength length, SchemaVersion version=Schema::Version)
 PositionMaintenanceReport503 (void *data, EncodedLength length, NoFieldsInit, SchemaVersion version=Schema::Version)
 PositionMaintenanceReport503 (void *data, EncodedLength length, NoInit)
 PositionMaintenanceReport503 (const SbeMessage &message)
 PositionMaintenanceReport503 (void *data, EncodedLength length, NoInit, NoCheck) noexcept
const OutboundBusinessHeaderbusinessHeader () const noexcept
OutboundBusinessHeaderbusinessHeader () noexcept
bool posReqId (PosReqIDOptional &value) const noexcept
ThisTypesetPosReqId (PosReqIDOptional value) noexcept
ThisTypesetPosReqIdToNull () noexcept
SecurityID securityId () const noexcept
ThisTypesetSecurityId (SecurityID value) noexcept
PosMaintRptID posMaintRptId () const noexcept
ThisTypesetPosMaintRptId (PosMaintRptID value) noexcept
PosTransType::Enum posTransType () const noexcept
ThisTypesetPosTransType (PosTransType::Enum value) noexcept
PosMaintAction::Enum posMaintAction () const noexcept
ThisTypesetPosMaintAction (PosMaintAction::Enum value) noexcept
PosMaintStatus::Enum posMaintStatus () const noexcept
ThisTypesetPosMaintStatus (PosMaintStatus::Enum value) noexcept
bool tradeId (TradeIDOptional &value) const noexcept
ThisTypesetTradeId (TradeIDOptional value) noexcept
ThisTypesetTradeIdToNull () noexcept
bool origPosReqRefId (PosReqIDOptional &value) const noexcept
ThisTypesetOrigPosReqRefId (PosReqIDOptional value) noexcept
ThisTypesetOrigPosReqRefIdToNull () noexcept
bool accountType (AccountType::Enum &value) const noexcept
ThisTypesetAccountType (AccountType::Enum value) noexcept
ThisTypesetAccountTypeToNull () noexcept
Timestamp clearingBusinessDate () const noexcept
ThisTypesetClearingBusinessDate (Timestamp value) noexcept
bool thresholdAmount (PriceOffsetOptional &value) const noexcept
ThisTypesetThresholdAmount (PriceOffsetOptional value) noexcept
ThisTypesetThresholdAmountToNull () noexcept
UTCTimestampNanos transactTime () const noexcept
ThisTypesetTransactTime (UTCTimestampNanos value) noexcept
bool account (AccountOptional &value) const noexcept
ThisTypesetAccount (AccountOptional value) noexcept
ThisTypesetAccountToNull () noexcept
StrRef senderLocation () const noexcept
ThisTypesetSenderLocation (StrRef value) noexcept
bool posMaintResult (RejReasonOptional &value) const noexcept
ThisTypesetPosMaintResult (RejReasonOptional value) noexcept
ThisTypesetPosMaintResultToNull () noexcept
Boolean::Enum contraryInstructionIndicator () const noexcept
ThisTypesetContraryInstructionIndicator (Boolean::Enum value) noexcept
Positions positions () const noexcept
Positions positions () noexcept
Positions positions (Positions::Size length)
Positions positions (Positions::Size length, NoFieldsInit)
StrRef deskId () const noexcept
StrRef memo () const noexcept
StrRef text () const noexcept
ThisTypesetDeskId (StrRef value)
ThisTypesetMemo (StrRef value)
ThisTypesetText (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 23443 of file Messages.h.

Member Typedef Documentation

◆ Positions

Repeating group containing PositionsEntry entries.

Definition at line 23623 of file Messages.h.

◆ Schema

Used template schema.

Definition at line 23448 of file Messages.h.

◆ ThisType

This type alias.

Definition at line 23451 of file Messages.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId 503 

Definition at line 23454 of file Messages.h.

Constructor & Destructor Documentation

◆ PositionMaintenanceReport503() [1/6]

Initializes a blank instance.

◆ PositionMaintenanceReport503() [2/6]

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

Initializes an instance over the given memory block.

Definition at line 23629 of file Messages.h.

◆ PositionMaintenanceReport503() [3/6]

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

◆ PositionMaintenanceReport503() [4/6]

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

Creates an instance over the given memory block.

Definition at line 23658 of file Messages.h.

◆ PositionMaintenanceReport503() [5/6]

PositionMaintenanceReport503 ( const SbeMessage & message)
inlineexplicit

Creates an instance over the given SBE message.

Definition at line 23669 of file Messages.h.

◆ PositionMaintenanceReport503() [6/6]

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

Creates an instance over the given memory block.

Performs no checks.

Definition at line 23680 of file Messages.h.

Member Function Documentation

◆ account()

bool account ( AccountOptional & value) const
inlinenoexcept

Account mnemonic of the order.

Definition at line 24049 of file Messages.h.

◆ accountType()

bool accountType ( AccountType::Enum & value) const
inlinenoexcept

Type of account associated with an order.

Definition at line 23943 of file Messages.h.

◆ blockLength()

constexpr BlockLength blockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept

Size of message body in bytes.

Definition at line 24275 of file Messages.h.

◆ businessHeader() [1/2]

const OutboundBusinessHeader & businessHeader ( ) const
inlinenoexcept

Message type = PositionMaintenanceReport.

Common header to all inbound business messages.

Definition at line 23707 of file Messages.h.

◆ businessHeader() [2/2]

OutboundBusinessHeader & businessHeader ( )
inlinenoexcept

Common header to all inbound business messages.

Definition at line 23716 of file Messages.h.

◆ calculateBinarySize()

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

Definition at line 24371 of file Messages.h.

◆ className()

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

Definition at line 24339 of file Messages.h.

◆ clearingBusinessDate()

Timestamp clearingBusinessDate ( ) const
inlinenoexcept

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

It must be set with the current date.

Definition at line 23973 of file Messages.h.

◆ contraryInstructionIndicator()

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

◆ deskId()

StrRef deskId ( ) const
inlinenoexcept

Identifies the trading desk.

Definition at line 24203 of file Messages.h.

◆ fixType()

constexpr StrRef fixType ( )
inlinestaticconstexprnoexcept

FIX message type.

Definition at line 24348 of file Messages.h.

◆ getMaxMessageSize()

constexpr UInt64 getMaxMessageSize ( UInt8 )
inlinestaticconstexprnoexcept

Maximal message size.

Definition at line 24301 of file Messages.h.

◆ getMinimalVariableFieldsSize()

constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion version)
inlinestaticconstexpr

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

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

◆ messageType()

constexpr MessageType::Enum messageType ( )
inlinestaticconstexprnoexcept

Message type = PositionMaintenanceReport.

Definition at line 23696 of file Messages.h.

◆ minimalBlockLength()

constexpr BlockLength minimalBlockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept

Minimal size of message body in bytes.

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

◆ positions() [1/4]

Positions positions ( ) const
inlinenoexcept
Returns
instance of Positions repeating group.

Definition at line 24163 of file Messages.h.

◆ positions() [2/4]

Positions positions ( )
inlinenoexcept
Returns
instance of Positions repeating group.

Definition at line 24171 of file Messages.h.

◆ positions() [3/4]

Positions positions ( Positions::Size length)
inline

Setup repeating group with the given number of entries.

Sets all optional fields of the group entries to null.

Returns
noPositions(702) repeating group.

Definition at line 24180 of file Messages.h.

◆ positions() [4/4]

Positions positions ( Positions::Size length,
NoFieldsInit  )
inline

Setup repeating group with the given number of entries.

Returns
noPositions(702) repeating group.

Definition at line 24191 of file Messages.h.

◆ posMaintAction()

PosMaintAction::Enum posMaintAction ( ) const
inlinenoexcept

Maintenance Action to be performed.

Definition at line 23835 of file Messages.h.

◆ posMaintResult()

bool posMaintResult ( RejReasonOptional & value) const
inlinenoexcept

Identifies reason for rejection.

Required when PosMaintStatus = 2.

Definition at line 24101 of file Messages.h.

◆ posMaintRptId()

PosMaintRptID posMaintRptId ( ) const
inlinenoexcept

Unique identifier for this position report.

Definition at line 23795 of file Messages.h.

◆ posMaintStatus()

PosMaintStatus::Enum posMaintStatus ( ) const
inlinenoexcept

Status of Position Maintenance Request.

Definition at line 23857 of file Messages.h.

◆ posReqId()

bool posReqId ( PosReqIDOptional & value) const
inlinenoexcept

Unique identifier for the position maintenance request.

Definition at line 23725 of file Messages.h.

◆ posTransType()

PosTransType::Enum posTransType ( ) const
inlinenoexcept

Identifies the type of position transaction.

Definition at line 23815 of file Messages.h.

◆ reset()

ThisType & reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 24320 of file Messages.h.

◆ resetVariableFields()

ThisType & resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

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

◆ securityId()

SecurityID securityId ( ) const
inlinenoexcept

Security identification as defined by exchange.

Definition at line 23754 of file Messages.h.

◆ securityIdSource()

constexpr SecurityIDSource::Enum securityIdSource ( )
inlinestaticconstexprnoexcept

Identifies the class of the SecurityID (Exchange Symbol).

Definition at line 23775 of file Messages.h.

◆ senderLocation()

StrRef senderLocation ( ) const
inlinenoexcept

Identifies the original location for routing orders.

Definition at line 24078 of file Messages.h.

◆ setAccount()

ThisType & setAccount ( AccountOptional value)
inlinenoexcept

Account mnemonic of the order.

Definition at line 24058 of file Messages.h.

◆ setAccountToNull()

ThisType & setAccountToNull ( )
inlinenoexcept

Definition at line 24067 of file Messages.h.

◆ setAccountType()

ThisType & setAccountType ( AccountType::Enum value)
inlinenoexcept

Type of account associated with an order.

Definition at line 23952 of file Messages.h.

◆ setAccountTypeToNull()

ThisType & setAccountTypeToNull ( )
inlinenoexcept

Definition at line 23961 of file Messages.h.

◆ setClearingBusinessDate()

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

◆ setContraryInstructionIndicator()

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

◆ setDeskId()

ThisType & setDeskId ( StrRef value)
inline

Identifies the trading desk.

Definition at line 24226 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 24237 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 23923 of file Messages.h.

◆ setOrigPosReqRefIdToNull()

ThisType & setOrigPosReqRefIdToNull ( )
inlinenoexcept

Definition at line 23932 of file Messages.h.

◆ setPosMaintAction()

ThisType & setPosMaintAction ( PosMaintAction::Enum value)
inlinenoexcept

Maintenance Action to be performed.

Definition at line 23845 of file Messages.h.

◆ setPosMaintResult()

ThisType & setPosMaintResult ( RejReasonOptional value)
inlinenoexcept

Identifies reason for rejection.

Required when PosMaintStatus = 2.

Definition at line 24111 of file Messages.h.

◆ setPosMaintResultToNull()

ThisType & setPosMaintResultToNull ( )
inlinenoexcept

Definition at line 24120 of file Messages.h.

◆ setPosMaintRptId()

ThisType & setPosMaintRptId ( PosMaintRptID value)
inlinenoexcept

Unique identifier for this position report.

Definition at line 23804 of file Messages.h.

◆ setPosMaintStatus()

ThisType & setPosMaintStatus ( PosMaintStatus::Enum value)
inlinenoexcept

Status of Position Maintenance Request.

Definition at line 23867 of file Messages.h.

◆ setPosReqId()

ThisType & setPosReqId ( PosReqIDOptional value)
inlinenoexcept

Unique identifier for the position maintenance request.

Definition at line 23734 of file Messages.h.

◆ setPosReqIdToNull()

ThisType & setPosReqIdToNull ( )
inlinenoexcept

Definition at line 23743 of file Messages.h.

◆ setPosTransType()

ThisType & setPosTransType ( PosTransType::Enum value)
inlinenoexcept

Identifies the type of position transaction.

Definition at line 23824 of file Messages.h.

◆ setSecurityId()

ThisType & setSecurityId ( SecurityID value)
inlinenoexcept

Security identification as defined by exchange.

Definition at line 23763 of file Messages.h.

◆ setSenderLocation()

ThisType & setSenderLocation ( StrRef value)
inlinenoexcept

Identifies the original location for routing orders.

Definition at line 24088 of file Messages.h.

◆ setText()

ThisType & setText ( StrRef value)
inline

Free ASCII format text string.

Definition at line 24248 of file Messages.h.

◆ setThresholdAmount()

ThisType & setThresholdAmount ( PriceOffsetOptional value)
inlinenoexcept

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

Definition at line 24008 of file Messages.h.

◆ setThresholdAmountToNull()

ThisType & setThresholdAmountToNull ( )
inlinenoexcept

Definition at line 24018 of file Messages.h.

◆ setTradeId()

ThisType & setTradeId ( TradeIDOptional value)
inlinenoexcept

The unique ID assigned to the trade entity once it is received or matched by the exchange or central counterparty.

Definition at line 23892 of file Messages.h.

◆ setTradeIdToNull()

ThisType & setTradeIdToNull ( )
inlinenoexcept

Definition at line 23901 of file Messages.h.

◆ setTransactTime()

ThisType & setTransactTime ( UTCTimestampNanos value)
inlinenoexcept

Time of execution/order creation.

Definition at line 24038 of file Messages.h.

◆ tail()

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

Definition at line 24361 of file Messages.h.

◆ text()

StrRef text ( ) const
inlinenoexcept

Free ASCII format text string.

Definition at line 24219 of file Messages.h.

◆ thresholdAmount()

bool thresholdAmount ( PriceOffsetOptional & value) const
inlinenoexcept

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

Definition at line 23996 of file Messages.h.

◆ toString()

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

Definition at line 1780 of file MessageSerialization.h.

◆ tradeId()

bool tradeId ( TradeIDOptional & value) const
inlinenoexcept

The unique ID assigned to the trade entity once it is received or matched by the exchange or central counterparty.

Definition at line 23881 of file Messages.h.

◆ transactTime()

UTCTimestampNanos transactTime ( ) const
inlinenoexcept

Time of execution/order creation.

Definition at line 24029 of file Messages.h.