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

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

Public Types

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

Public Member Functions

 AllocationInstruction601 ()=default
 
 AllocationInstruction601 (void *data, EncodedLength length, SchemaVersion version=Schema::Version)
 
 AllocationInstruction601 (void *data, EncodedLength length, NoFieldsInit, SchemaVersion version=Schema::Version)
 
 AllocationInstruction601 (void *data, EncodedLength length, NoInit)
 
 AllocationInstruction601 (const SbeMessage &message)
 
 AllocationInstruction601 (void *data, EncodedLength length, NoInit, NoCheck) noexcept
 
const InboundBusinessHeaderbusinessHeader () const noexcept
 
InboundBusinessHeaderbusinessHeader () noexcept
 
AllocID allocId () const noexcept
 
ThisTypesetAllocId (AllocID value) noexcept
 
SecurityID securityId () const noexcept
 
ThisTypesetSecurityId (SecurityID value) noexcept
 
AllocTransType::Enum allocTransType () const noexcept
 
ThisTypesetAllocTransType (AllocTransType::Enum value) noexcept
 
AllocType::Enum allocType () const noexcept
 
ThisTypesetAllocType (AllocType::Enum value) noexcept
 
AllocNoOrdersType::Enum allocNoOrdersType () const noexcept
 
ThisTypesetAllocNoOrdersType (AllocNoOrdersType::Enum value) noexcept
 
Quantity quantity () const noexcept
 
ThisTypesetQuantity (Quantity value) noexcept
 
StrRef senderLocation () const noexcept
 
ThisTypesetSenderLocation (StrRef value) noexcept
 
StrRef enteringTrader () const noexcept
 
ThisTypesetEnteringTrader (StrRef value) noexcept
 
TradeID tradeId () const noexcept
 
ThisTypesetTradeId (TradeID value) noexcept
 
bool tradeDate (Timestamp &value) const noexcept
 
ThisTypesetTradeDate (Timestamp value) noexcept
 
ThisTypesetTradeDateToNull () noexcept
 
AllocID individualAllocId () const noexcept
 
ThisTypesetIndividualAllocId (AllocID value) noexcept
 
Account allocAccount () const noexcept
 
ThisTypesetAllocAccount (Account value) noexcept
 
Quantity allocQty () const noexcept
 
ThisTypesetAllocQty (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 Side::Enum side () 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 24076 of file Messages.h.

Member Typedef Documentation

Used template schema.

Definition at line 24081 of file Messages.h.

This type alias.

Definition at line 24084 of file Messages.h.

Member Enumeration Documentation

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId 

Definition at line 24087 of file Messages.h.

Constructor & Destructor Documentation

Initializes a blank instance.

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

Initializes an instance over the given memory block.

Definition at line 24093 of file Messages.h.

AllocationInstruction601 ( 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 24108 of file Messages.h.

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

Creates an instance over the given memory block.

Definition at line 24122 of file Messages.h.

AllocationInstruction601 ( const SbeMessage message)
inlineexplicit

Creates an instance over the given SBE message.

Definition at line 24133 of file Messages.h.

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

Creates an instance over the given memory block.

Performs no checks.

Definition at line 24144 of file Messages.h.

Member Function Documentation

Account allocAccount ( ) const
inlinenoexcept

Sub-account mnemonic.

Definition at line 24479 of file Messages.h.

AllocID allocId ( ) const
inlinenoexcept

Unique identifier for this allocation instruction message.

Definition at line 24189 of file Messages.h.

AllocNoOrdersType::Enum allocNoOrdersType ( ) const
inlinenoexcept

Indicates how the orders being booked and allocated by an Allocation Instruction.

Definition at line 24295 of file Messages.h.

Quantity allocQty ( ) const
inlinenoexcept

Quantity allocated to specific sub-account.

Definition at line 24499 of file Messages.h.

AllocTransType::Enum allocTransType ( ) const
inlinenoexcept

Identifies allocation transaction type.

Definition at line 24250 of file Messages.h.

AllocType::Enum allocType ( ) const
inlinenoexcept

Describes the specific type or purpose of an Allocation message.

Definition at line 24273 of file Messages.h.

static constexpr BlockLength blockLength ( SchemaVersion  version)
inlinestaticnoexcept

Size of message body in bytes.

Definition at line 24572 of file Messages.h.

const InboundBusinessHeader& businessHeader ( ) const
inlinenoexcept

Message type = AllocationInstruction.

Common header to all inbound business messages.

Definition at line 24171 of file Messages.h.

InboundBusinessHeader& businessHeader ( )
inlinenoexcept

Common header to all inbound business messages.

Definition at line 24180 of file Messages.h.

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

Definition at line 24660 of file Messages.h.

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

Definition at line 24628 of file Messages.h.

StrRef deskId ( ) const
inlinenoexcept

Identifies the trading desk.

Definition at line 24519 of file Messages.h.

StrRef enteringTrader ( ) const
inlinenoexcept

Identifies the trader who is inserting an order.

Definition at line 24371 of file Messages.h.

static constexpr StrRef fixType ( )
inlinestaticnoexcept

FIX message type.

Definition at line 24637 of file Messages.h.

static constexpr UInt64 getMaxMessageSize ( UInt8  )
inlinestaticnoexcept

Maximal message size.

Definition at line 24598 of file Messages.h.

static constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion  version)
inlinestatic

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

Definition at line 24586 of file Messages.h.

AllocID individualAllocId ( ) const
inlinenoexcept

Unique identifier for a specific NoAllocs (78) repeating group instance (e.g.

for an AllocAccount).

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

static constexpr MessageType::Enum messageType ( )
inlinestaticnoexcept

Message type = AllocationInstruction.

Definition at line 24160 of file Messages.h.

static constexpr BlockLength minimalBlockLength ( SchemaVersion  version)
inlinestaticnoexcept

Minimal size of message body in bytes.

Definition at line 24560 of file Messages.h.

Quantity quantity ( ) const
inlinenoexcept

Overall/total quantity (e.g. number of shares).

Definition at line 24318 of file Messages.h.

ThisType& reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 24615 of file Messages.h.

ThisType& resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

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

SecurityID securityId ( ) const
inlinenoexcept

Security identification as defined by exchange.

Definition at line 24209 of file Messages.h.

static constexpr SecurityIDSource::Enum securityIdSource ( )
inlinestaticnoexcept

Identifies the class of the SecurityID (Exchange Symbol).

Definition at line 24230 of file Messages.h.

StrRef senderLocation ( ) const
inlinenoexcept

Side of order.

Identifies the original location for routing orders.

Definition at line 24349 of file Messages.h.

ThisType& setAllocAccount ( Account  value)
inlinenoexcept

Sub-account mnemonic.

Definition at line 24488 of file Messages.h.

ThisType& setAllocId ( AllocID  value)
inlinenoexcept

Unique identifier for this allocation instruction message.

Definition at line 24198 of file Messages.h.

ThisType& setAllocNoOrdersType ( AllocNoOrdersType::Enum  value)
inlinenoexcept

Indicates how the orders being booked and allocated by an Allocation Instruction.

Definition at line 24306 of file Messages.h.

ThisType& setAllocQty ( Quantity  value)
inlinenoexcept

Quantity allocated to specific sub-account.

Definition at line 24508 of file Messages.h.

ThisType& setAllocTransType ( AllocTransType::Enum  value)
inlinenoexcept

Identifies allocation transaction type.

Definition at line 24260 of file Messages.h.

ThisType& setAllocType ( AllocType::Enum  value)
inlinenoexcept

Describes the specific type or purpose of an Allocation message.

Definition at line 24283 of file Messages.h.

ThisType& setDeskId ( StrRef  value)
inline

Identifies the trading desk.

Definition at line 24534 of file Messages.h.

ThisType& setEnteringTrader ( StrRef  value)
inlinenoexcept

Identifies the trader who is inserting an order.

Definition at line 24381 of file Messages.h.

ThisType& setIndividualAllocId ( AllocID  value)
inlinenoexcept

Unique identifier for a specific NoAllocs (78) repeating group instance (e.g.

for an AllocAccount).

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

ThisType& setQuantity ( Quantity  value)
inlinenoexcept

Overall/total quantity (e.g. number of shares).

Definition at line 24327 of file Messages.h.

ThisType& setSecurityId ( SecurityID  value)
inlinenoexcept

Security identification as defined by exchange.

Definition at line 24218 of file Messages.h.

ThisType& setSenderLocation ( StrRef  value)
inlinenoexcept

Identifies the original location for routing orders.

Definition at line 24359 of file Messages.h.

ThisType& setTradeDate ( Timestamp  value)
inlinenoexcept

Indicates date of trading day (expressed in local time at place of trade).

Sent in number of days since Unix epoch.

Definition at line 24437 of file Messages.h.

ThisType& setTradeDateToNull ( )
inlinenoexcept

Definition at line 24446 of file Messages.h.

ThisType& setTradeId ( TradeID  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 24406 of file Messages.h.

static constexpr Side::Enum side ( )
inlinestaticnoexcept

Side of order.

Definition at line 24339 of file Messages.h.

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

Definition at line 24650 of file Messages.h.

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

Definition at line 1861 of file MessageSerialization.h.

bool tradeDate ( Timestamp value) const
inlinenoexcept

Indicates date of trading day (expressed in local time at place of trade).

Sent in number of days since Unix epoch.

Definition at line 24418 of file Messages.h.

TradeID tradeId ( ) 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 24395 of file Messages.h.


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