PositionMaintenanceReport503 Struct Reference

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

Classes
struct	PositionsEntry

Public Types
enum	{ TemplateId = 503 }
typedef SchemaTraits	Schema
typedef PositionMaintenanceReport503	ThisType
typedef SbeGroup< PositionsEntry, GroupSizeEncoding, MessageSize >	Positions
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 OutboundBusinessHeader &	businessHeader () const noexcept
OutboundBusinessHeader &	businessHeader () noexcept
bool	posReqId (PosReqIDOptional &value) const noexcept
ThisType &	setPosReqId (PosReqIDOptional value) noexcept
ThisType &	setPosReqIdToNull () noexcept
SecurityID	securityId () const noexcept
ThisType &	setSecurityId (SecurityID value) noexcept
PosMaintRptID	posMaintRptId () const noexcept
ThisType &	setPosMaintRptId (PosMaintRptID value) noexcept
PosTransType::Enum	posTransType () const noexcept
ThisType &	setPosTransType (PosTransType::Enum value) noexcept
PosMaintAction::Enum	posMaintAction () const noexcept
ThisType &	setPosMaintAction (PosMaintAction::Enum value) noexcept
PosMaintStatus::Enum	posMaintStatus () const noexcept
ThisType &	setPosMaintStatus (PosMaintStatus::Enum value) noexcept
bool	tradeId (TradeIDOptional &value) const noexcept
ThisType &	setTradeId (TradeIDOptional value) noexcept
ThisType &	setTradeIdToNull () noexcept
bool	origPosReqRefId (PosReqIDOptional &value) const noexcept
ThisType &	setOrigPosReqRefId (PosReqIDOptional value) noexcept
ThisType &	setOrigPosReqRefIdToNull () noexcept
bool	accountType (AccountType::Enum &value) const noexcept
ThisType &	setAccountType (AccountType::Enum value) noexcept
ThisType &	setAccountTypeToNull () noexcept
Timestamp	clearingBusinessDate () const noexcept
ThisType &	setClearingBusinessDate (Timestamp value) noexcept
bool	thresholdAmount (PriceOffsetOptional &value) const noexcept
ThisType &	setThresholdAmount (PriceOffsetOptional value) noexcept
ThisType &	setThresholdAmountToNull () noexcept
UTCTimestampNanos	transactTime () const noexcept
ThisType &	setTransactTime (UTCTimestampNanos value) noexcept
bool	account (AccountOptional &value) const noexcept
ThisType &	setAccount (AccountOptional value) noexcept
ThisType &	setAccountToNull () noexcept
StrRef	senderLocation () const noexcept
ThisType &	setSenderLocation (StrRef value) noexcept
bool	posMaintResult (RejReasonOptional &value) const noexcept
ThisType &	setPosMaintResult (RejReasonOptional value) noexcept
ThisType &	setPosMaintResultToNull () noexcept
Boolean::Enum	contraryInstructionIndicator () const noexcept
ThisType &	setContraryInstructionIndicator (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
ThisType &	setDeskId (StrRef value)
ThisType &	setMemo (StrRef value)
ThisType &	setText (StrRef value)
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 (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 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 (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 23001 of file Messages.h.

Member Typedef Documentation

typedef SbeGroup<PositionsEntry, GroupSizeEncoding, MessageSize> Positions

Repeating group containing PositionsEntry entries.

Definition at line 23181 of file Messages.h.

typedef SchemaTraits Schema

Used template schema.

Definition at line 23006 of file Messages.h.

typedef PositionMaintenanceReport503 ThisType

This type alias.

Definition at line 23009 of file Messages.h.

Member Enumeration Documentation

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId

Definition at line 23012 of file Messages.h.

Constructor & Destructor Documentation

PositionMaintenanceReport503 ( )

default

Initializes a blank instance.

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

inline

Initializes an instance over the given memory block.

Definition at line 23187 of file Messages.h.

PositionMaintenanceReport503 ( 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 23202 of file Messages.h.

PositionMaintenanceReport503 ( void *  data, EncodedLength  length, NoInit    )

inline

Creates an instance over the given memory block.

Definition at line 23216 of file Messages.h.

PositionMaintenanceReport503 ( const SbeMessage &  message )

inlineexplicit

Creates an instance over the given SBE message.

Definition at line 23227 of file Messages.h.

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

inlinenoexcept

Creates an instance over the given memory block.

Performs no checks.

Definition at line 23238 of file Messages.h.

Member Function Documentation

bool account ( AccountOptional &  value ) const

inlinenoexcept

Account mnemonic of the order.

Definition at line 23613 of file Messages.h.

bool accountType ( AccountType::Enum &  value ) const

inlinenoexcept

Type of account associated with an order.

Definition at line 23501 of file Messages.h.

static constexpr BlockLength blockLength ( SchemaVersion  version )

inlinestaticnoexcept

Size of message body in bytes.

Definition at line 23839 of file Messages.h.

const OutboundBusinessHeader& businessHeader ( ) const

inlinenoexcept

Message type = PositionMaintenanceReport.

Common header to all inbound business messages.

Definition at line 23265 of file Messages.h.

OutboundBusinessHeader& businessHeader ( )

inlinenoexcept

Common header to all inbound business messages.

Definition at line 23274 of file Messages.h.

EncodedLength calculateBinarySize ( ) const

inlinenoexcept

Returns

the size occupied by the message.

Definition at line 23935 of file Messages.h.

static constexpr const Char* className ( )

inlinestatic

Returns

class name.

Definition at line 23903 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 23531 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 23701 of file Messages.h.

StrRef deskId ( ) const

inlinenoexcept

Identifies the trading desk.

Definition at line 23767 of file Messages.h.

static constexpr StrRef fixType ( )

inlinestaticnoexcept

FIX message type.

Definition at line 23912 of file Messages.h.

static constexpr UInt64 getMaxMessageSize ( UInt8  )

inlinestaticnoexcept

Maximal message size.

Definition at line 23865 of file Messages.h.

static constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion  version )

inlinestatic

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

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

static constexpr MessageType::Enum messageType ( )

inlinestaticnoexcept

Message type = PositionMaintenanceReport.

Definition at line 23254 of file Messages.h.

static constexpr BlockLength minimalBlockLength ( SchemaVersion  version )

inlinestaticnoexcept

Minimal size of message body in bytes.

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

Positions positions ( ) const

inlinenoexcept

Returns

instance of Positions repeating group.

Definition at line 23727 of file Messages.h.

Positions positions ( )

inlinenoexcept

Returns

instance of Positions repeating group.

Definition at line 23735 of file Messages.h.

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

Positions positions ( Positions::Size  length, NoFieldsInit    )

inline

Setup repeating group with the given number of entries.

Returns

noPositions(702) repeating group.

Definition at line 23755 of file Messages.h.

PosMaintAction::Enum posMaintAction ( ) const

inlinenoexcept

Maintenance Action to be performed.

Definition at line 23393 of file Messages.h.

bool posMaintResult ( RejReasonOptional &  value ) const

inlinenoexcept

Identifies reason for rejection.

Required when PosMaintStatus = 2.

Definition at line 23665 of file Messages.h.

PosMaintRptID posMaintRptId ( ) const

inlinenoexcept

Unique identifier for this position report.

Definition at line 23353 of file Messages.h.

PosMaintStatus::Enum posMaintStatus ( ) const

inlinenoexcept

Status of Position Maintenance Request.

Definition at line 23415 of file Messages.h.

bool posReqId ( PosReqIDOptional &  value ) const

inlinenoexcept

Unique identifier for the position maintenance request.

Definition at line 23283 of file Messages.h.

PosTransType::Enum posTransType ( ) const

inlinenoexcept

Identifies the type of position transaction.

Definition at line 23373 of file Messages.h.

ThisType& reset ( )

inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 23884 of file Messages.h.

ThisType& resetVariableFields ( )

inlinenoexcept

Reset all variable-length fields if any.

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

SecurityID securityId ( ) const

inlinenoexcept

Security identification as defined by exchange.

Definition at line 23312 of file Messages.h.

static constexpr SecurityIDSource::Enum securityIdSource ( )

inlinestaticnoexcept

Identifies the class of the SecurityID (Exchange Symbol).

Definition at line 23333 of file Messages.h.

StrRef senderLocation ( ) const

inlinenoexcept

Identifies the original location for routing orders.

Definition at line 23642 of file Messages.h.

ThisType& setAccount ( AccountOptional  value )

inlinenoexcept

Account mnemonic of the order.

Definition at line 23622 of file Messages.h.

ThisType& setAccountToNull ( )

inlinenoexcept

Definition at line 23631 of file Messages.h.

ThisType& setAccountType ( AccountType::Enum  value )

inlinenoexcept

Type of account associated with an order.

Definition at line 23510 of file Messages.h.

ThisType& setAccountTypeToNull ( )

inlinenoexcept

Definition at line 23519 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 23541 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 23716 of file Messages.h.

ThisType& setDeskId ( StrRef  value )

inline

Identifies the trading desk.

Definition at line 23790 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 23801 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 23481 of file Messages.h.

ThisType& setOrigPosReqRefIdToNull ( )

inlinenoexcept

Definition at line 23490 of file Messages.h.

ThisType& setPosMaintAction ( PosMaintAction::Enum  value )

inlinenoexcept

Maintenance Action to be performed.

Definition at line 23403 of file Messages.h.

ThisType& setPosMaintResult ( RejReasonOptional  value )

inlinenoexcept

Identifies reason for rejection.

Required when PosMaintStatus = 2.

Definition at line 23675 of file Messages.h.

ThisType& setPosMaintResultToNull ( )

inlinenoexcept

Definition at line 23684 of file Messages.h.

ThisType& setPosMaintRptId ( PosMaintRptID  value )

inlinenoexcept

Unique identifier for this position report.

Definition at line 23362 of file Messages.h.

ThisType& setPosMaintStatus ( PosMaintStatus::Enum  value )

inlinenoexcept

Status of Position Maintenance Request.

Definition at line 23425 of file Messages.h.

ThisType& setPosReqId ( PosReqIDOptional  value )

inlinenoexcept

Unique identifier for the position maintenance request.

Definition at line 23292 of file Messages.h.

ThisType& setPosReqIdToNull ( )

inlinenoexcept

Definition at line 23301 of file Messages.h.

ThisType& setPosTransType ( PosTransType::Enum  value )

inlinenoexcept

Identifies the type of position transaction.

Definition at line 23382 of file Messages.h.

ThisType& setSecurityId ( SecurityID  value )

inlinenoexcept

Security identification as defined by exchange.

Definition at line 23321 of file Messages.h.

ThisType& setSenderLocation ( StrRef  value )

inlinenoexcept

Identifies the original location for routing orders.

Definition at line 23652 of file Messages.h.

ThisType& setText ( StrRef  value )

inline

Free ASCII format text string.

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

ThisType& setThresholdAmountToNull ( )

inlinenoexcept

Definition at line 23576 of file Messages.h.

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

ThisType& setTradeIdToNull ( )

inlinenoexcept

Definition at line 23459 of file Messages.h.

ThisType& setTransactTime ( UTCTimestampNanos  value )

inlinenoexcept

Time of execution/order creation; expressed in UTC.

Please note that although the clock is specified in nanoseconds, the actual accuracy of the exchange's clocks is milliseconds.

Definition at line 23602 of file Messages.h.

const void* tail ( ) const

inlinenoexcept

Returns

the end of the message.

Definition at line 23925 of file Messages.h.

StrRef text ( ) const

inlinenoexcept

Free ASCII format text string.

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

std::string toString ( ) const

inline

Returns

a human-readable presentation.

Definition at line 1780 of file MessageSerialization.h.

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

UTCTimestampNanos transactTime ( ) const

inlinenoexcept

Time of execution/order creation; expressed in UTC.

Please note that although the clock is specified in nanoseconds, the actual accuracy of the exchange's clocks is milliseconds.

Definition at line 23590 of file Messages.h.

---

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

• OnixS/B3/BOE/messaging/Messages.h
• OnixS/B3/BOE/messaging/MessageSerialization.h