PositionMaintenanceRequest502 Struct Reference

Public Types
enum
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 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	thresholdAmount (PriceOffsetOptional &value) const noexcept
ThisType &	setThresholdAmount (PriceOffsetOptional value) noexcept
ThisType &	setThresholdAmountToNull () noexcept
bool	account (AccountOptional &value) const noexcept
ThisType &	setAccount (AccountOptional value) noexcept
ThisType &	setAccountToNull () noexcept
StrRef	senderLocation () const noexcept
ThisType &	setSenderLocation (StrRef value) noexcept
PosTransType::Enum	posTransType () const noexcept
ThisType &	setPosTransType (PosTransType::Enum value) noexcept
Timestamp	clearingBusinessDate () const noexcept
ThisType &	setClearingBusinessDate (Timestamp value) noexcept
Boolean::Enum	contraryInstructionIndicator () const noexcept
ThisType &	setContraryInstructionIndicator (Boolean::Enum value) noexcept
StrRef	enteringTrader () const noexcept
ThisType &	setEnteringTrader (StrRef value) noexcept
Quantity	longQty () const noexcept
ThisType &	setLongQty (Quantity value) noexcept
StrRef	deskId () const noexcept
StrRef	memo () const noexcept
ThisType &	setDeskId (StrRef value)
ThisType &	setMemo (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 (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 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 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 22826 of file Messages.h.

Member Typedef Documentation

Schema

typedef SchemaTraits Schema

Used template schema.

Definition at line 22831 of file Messages.h.

ThisType

typedef PositionMaintenanceRequest502 ThisType

This type alias.

Definition at line 22834 of file Messages.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId	502

Definition at line 22837 of file Messages.h.

Constructor & Destructor Documentation

PositionMaintenanceRequest502() [1/6]

PositionMaintenanceRequest502 ( )

default

Initializes a blank instance.

PositionMaintenanceRequest502() [2/6]

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

inline

Initializes an instance over the given memory block.

Definition at line 22843 of file Messages.h.

PositionMaintenanceRequest502() [3/6]

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

PositionMaintenanceRequest502() [4/6]

PositionMaintenanceRequest502 ( void * data, EncodedLength length, NoInit  )

inline

Creates an instance over the given memory block.

Definition at line 22872 of file Messages.h.

PositionMaintenanceRequest502() [5/6]

PositionMaintenanceRequest502 ( const SbeMessage & message )

inlineexplicit

Creates an instance over the given SBE message.

Definition at line 22883 of file Messages.h.

PositionMaintenanceRequest502() [6/6]

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

inlinenoexcept

Creates an instance over the given memory block.

Performs no checks.

Definition at line 22894 of file Messages.h.

Member Function Documentation

account()

bool account ( AccountOptional & value ) const

inlinenoexcept

Account mnemonic of the order.

Definition at line 23035 of file Messages.h.

blockLength()

constexpr BlockLength blockLength ( SchemaVersion version )

inlinestaticconstexprnoexcept

Size of message body in bytes.

Definition at line 23266 of file Messages.h.

businessHeader() [1/2]

const InboundBusinessHeader & businessHeader ( ) const

inlinenoexcept

Message type = PositionMaintenanceRequest.

Common header to all inbound business messages.

Definition at line 22921 of file Messages.h.

businessHeader() [2/2]

InboundBusinessHeader & businessHeader ( )

inlinenoexcept

Common header to all inbound business messages.

Definition at line 22930 of file Messages.h.

calculateBinarySize()

EncodedLength calculateBinarySize ( ) const

inlinenoexcept

Returns

the size occupied by the message.

Definition at line 23355 of file Messages.h.

className()

constexpr const Char * className ( )

inlinestaticconstexpr

Returns

class name.

Definition at line 23323 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 23107 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 23134 of file Messages.h.

deskId()

StrRef deskId ( ) const

inlinenoexcept

Identifies the trading desk.

Definition at line 23213 of file Messages.h.

enteringTrader()

StrRef enteringTrader ( ) const

inlinenoexcept

Identifies the trader who is inserting an order.

Definition at line 23160 of file Messages.h.

fixType()

constexpr StrRef fixType ( )

inlinestaticconstexprnoexcept

FIX message type.

Definition at line 23332 of file Messages.h.

getMaxMessageSize()

constexpr UInt64 getMaxMessageSize ( UInt8 )

inlinestaticconstexprnoexcept

Maximal message size.

Definition at line 23292 of file Messages.h.

getMinimalVariableFieldsSize()

constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion version )

inlinestaticconstexpr

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

Definition at line 23280 of file Messages.h.

longQty()

Quantity longQty ( ) const

inlinenoexcept

Used to identify the type of quantity.

Long quantity.

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

messageType()

constexpr MessageType::Enum messageType ( )

inlinestaticconstexprnoexcept

Message type = PositionMaintenanceRequest.

Definition at line 22910 of file Messages.h.

minimalBlockLength()

constexpr BlockLength minimalBlockLength ( SchemaVersion version )

inlinestaticconstexprnoexcept

Minimal size of message body in bytes.

Definition at line 23254 of file Messages.h.

posReqId()

PosReqID posReqId ( ) const

inlinenoexcept

Unique identifier for the position maintenance request.

Definition at line 22939 of file Messages.h.

posTransType()

PosTransType::Enum posTransType ( ) const

inlinenoexcept

Identifies the type of position transaction.

Definition at line 23086 of file Messages.h.

posType()

constexpr PosType::Enum posType ( )

inlinestaticconstexprnoexcept

Used to identify the type of quantity.

Definition at line 23183 of file Messages.h.

reset()

ThisType & reset ( )

inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 23309 of file Messages.h.

resetVariableFields()

ThisType & resetVariableFields ( )

inlinenoexcept

Reset all variable-length fields if any.

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

securityId()

SecurityID securityId ( ) const

inlinenoexcept

Security identification as defined by exchange.

Definition at line 22959 of file Messages.h.

securityIdSource()

constexpr SecurityIDSource::Enum securityIdSource ( )

inlinestaticconstexprnoexcept

Identifies the class of the SecurityID (Exchange Symbol).

Definition at line 22980 of file Messages.h.

senderLocation()

StrRef senderLocation ( ) const

inlinenoexcept

Identifies the original location for routing orders.

Definition at line 23064 of file Messages.h.

setAccount()

ThisType & setAccount ( AccountOptional value )

inlinenoexcept

Account mnemonic of the order.

Definition at line 23044 of file Messages.h.

setAccountToNull()

ThisType & setAccountToNull ( )

inlinenoexcept

Definition at line 23053 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 23117 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 23149 of file Messages.h.

setDeskId()

ThisType & setDeskId ( StrRef value )

inline

Identifies the trading desk.

Definition at line 23228 of file Messages.h.

setEnteringTrader()

ThisType & setEnteringTrader ( StrRef value )

inlinenoexcept

Identifies the trader who is inserting an order.

Definition at line 23170 of file Messages.h.

setLongQty()

ThisType & setLongQty ( Quantity value )

inlinenoexcept

Long quantity.

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

setPosReqId()

ThisType & setPosReqId ( PosReqID value )

inlinenoexcept

Unique identifier for the position maintenance request.

Definition at line 22948 of file Messages.h.

setPosTransType()

ThisType & setPosTransType ( PosTransType::Enum value )

inlinenoexcept

Identifies the type of position transaction.

Definition at line 23095 of file Messages.h.

setSecurityId()

ThisType & setSecurityId ( SecurityID value )

inlinenoexcept

Security identification as defined by exchange.

Definition at line 22968 of file Messages.h.

setSenderLocation()

ThisType & setSenderLocation ( StrRef value )

inlinenoexcept

Identifies the original location for routing orders.

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

setThresholdAmountToNull()

ThisType & setThresholdAmountToNull ( )

inlinenoexcept

Definition at line 23024 of file Messages.h.

tail()

const void * tail ( ) const

inlinenoexcept

Returns

the end of the message.

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

toString()

std::string toString ( ) const

inline

Returns

a human-readable presentation.

Definition at line 1733 of file MessageSerialization.h.