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

Public Types

enum  
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 (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 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 (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 24512 of file Messages.h.

Member Typedef Documentation

◆ Schema

Used template schema.

Definition at line 24517 of file Messages.h.

◆ ThisType

This type alias.

Definition at line 24520 of file Messages.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId 601 

Definition at line 24523 of file Messages.h.

Constructor & Destructor Documentation

◆ AllocationInstruction601() [1/6]

Initializes a blank instance.

◆ AllocationInstruction601() [2/6]

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

Initializes an instance over the given memory block.

Definition at line 24529 of file Messages.h.

◆ AllocationInstruction601() [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 24544 of file Messages.h.

◆ AllocationInstruction601() [4/6]

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

Creates an instance over the given memory block.

Definition at line 24558 of file Messages.h.

◆ AllocationInstruction601() [5/6]

AllocationInstruction601 ( const SbeMessage & message)
inlineexplicit

Creates an instance over the given SBE message.

Definition at line 24569 of file Messages.h.

◆ AllocationInstruction601() [6/6]

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

Creates an instance over the given memory block.

Performs no checks.

Definition at line 24580 of file Messages.h.

Member Function Documentation

◆ allocAccount()

Account allocAccount ( ) const
inlinenoexcept

Sub-account mnemonic.

Definition at line 24915 of file Messages.h.

◆ allocId()

AllocID allocId ( ) const
inlinenoexcept

Unique identifier for this allocation instruction message.

Definition at line 24625 of file Messages.h.

◆ allocNoOrdersType()

AllocNoOrdersType::Enum allocNoOrdersType ( ) const
inlinenoexcept

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

Definition at line 24731 of file Messages.h.

◆ allocQty()

Quantity allocQty ( ) const
inlinenoexcept

Quantity allocated to specific sub-account.

Definition at line 24935 of file Messages.h.

◆ allocTransType()

AllocTransType::Enum allocTransType ( ) const
inlinenoexcept

Identifies allocation transaction type.

Definition at line 24686 of file Messages.h.

◆ allocType()

AllocType::Enum allocType ( ) const
inlinenoexcept

Describes the specific type or purpose of an Allocation message.

Definition at line 24709 of file Messages.h.

◆ blockLength()

constexpr BlockLength blockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept

Size of message body in bytes.

Definition at line 25008 of file Messages.h.

◆ businessHeader() [1/2]

const InboundBusinessHeader & businessHeader ( ) const
inlinenoexcept

Message type = AllocationInstruction.

Common header to all inbound business messages.

Definition at line 24607 of file Messages.h.

◆ businessHeader() [2/2]

InboundBusinessHeader & businessHeader ( )
inlinenoexcept

Common header to all inbound business messages.

Definition at line 24616 of file Messages.h.

◆ calculateBinarySize()

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

Definition at line 25096 of file Messages.h.

◆ className()

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

Definition at line 25064 of file Messages.h.

◆ deskId()

StrRef deskId ( ) const
inlinenoexcept

Identifies the trading desk.

Definition at line 24955 of file Messages.h.

◆ enteringTrader()

StrRef enteringTrader ( ) const
inlinenoexcept

Identifies the trader who is inserting an order.

Definition at line 24807 of file Messages.h.

◆ fixType()

constexpr StrRef fixType ( )
inlinestaticconstexprnoexcept

FIX message type.

Definition at line 25073 of file Messages.h.

◆ getMaxMessageSize()

constexpr UInt64 getMaxMessageSize ( UInt8 )
inlinestaticconstexprnoexcept

Maximal message size.

Definition at line 25034 of file Messages.h.

◆ getMinimalVariableFieldsSize()

constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion version)
inlinestaticconstexpr

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

Definition at line 25022 of file Messages.h.

◆ individualAllocId()

AllocID individualAllocId ( ) const
inlinenoexcept

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

for an AllocAccount).

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

◆ messageType()

constexpr MessageType::Enum messageType ( )
inlinestaticconstexprnoexcept

Message type = AllocationInstruction.

Definition at line 24596 of file Messages.h.

◆ minimalBlockLength()

constexpr BlockLength minimalBlockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept

Minimal size of message body in bytes.

Definition at line 24996 of file Messages.h.

◆ quantity()

Quantity quantity ( ) const
inlinenoexcept

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

Definition at line 24754 of file Messages.h.

◆ reset()

ThisType & reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 25051 of file Messages.h.

◆ resetVariableFields()

ThisType & resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

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

◆ securityId()

SecurityID securityId ( ) const
inlinenoexcept

Security identification as defined by exchange.

Definition at line 24645 of file Messages.h.

◆ securityIdSource()

constexpr SecurityIDSource::Enum securityIdSource ( )
inlinestaticconstexprnoexcept

Identifies the class of the SecurityID (Exchange Symbol).

Definition at line 24666 of file Messages.h.

◆ senderLocation()

StrRef senderLocation ( ) const
inlinenoexcept

Side of order.

Identifies the original location for routing orders.

Definition at line 24785 of file Messages.h.

◆ setAllocAccount()

ThisType & setAllocAccount ( Account value)
inlinenoexcept

Sub-account mnemonic.

Definition at line 24924 of file Messages.h.

◆ setAllocId()

ThisType & setAllocId ( AllocID value)
inlinenoexcept

Unique identifier for this allocation instruction message.

Definition at line 24634 of file Messages.h.

◆ setAllocNoOrdersType()

ThisType & setAllocNoOrdersType ( AllocNoOrdersType::Enum value)
inlinenoexcept

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

Definition at line 24742 of file Messages.h.

◆ setAllocQty()

ThisType & setAllocQty ( Quantity value)
inlinenoexcept

Quantity allocated to specific sub-account.

Definition at line 24944 of file Messages.h.

◆ setAllocTransType()

ThisType & setAllocTransType ( AllocTransType::Enum value)
inlinenoexcept

Identifies allocation transaction type.

Definition at line 24696 of file Messages.h.

◆ setAllocType()

ThisType & setAllocType ( AllocType::Enum value)
inlinenoexcept

Describes the specific type or purpose of an Allocation message.

Definition at line 24719 of file Messages.h.

◆ setDeskId()

ThisType & setDeskId ( StrRef value)
inline

Identifies the trading desk.

Definition at line 24970 of file Messages.h.

◆ setEnteringTrader()

ThisType & setEnteringTrader ( StrRef value)
inlinenoexcept

Identifies the trader who is inserting an order.

Definition at line 24817 of file Messages.h.

◆ setIndividualAllocId()

ThisType & setIndividualAllocId ( AllocID value)
inlinenoexcept

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

for an AllocAccount).

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

◆ setQuantity()

ThisType & setQuantity ( Quantity value)
inlinenoexcept

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

Definition at line 24763 of file Messages.h.

◆ setSecurityId()

ThisType & setSecurityId ( SecurityID value)
inlinenoexcept

Security identification as defined by exchange.

Definition at line 24654 of file Messages.h.

◆ setSenderLocation()

ThisType & setSenderLocation ( StrRef value)
inlinenoexcept

Identifies the original location for routing orders.

Definition at line 24795 of file Messages.h.

◆ setTradeDate()

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

◆ setTradeDateToNull()

ThisType & setTradeDateToNull ( )
inlinenoexcept

Definition at line 24882 of file Messages.h.

◆ setTradeId()

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

◆ side()

constexpr Side::Enum side ( )
inlinestaticconstexprnoexcept

Side of order.

Definition at line 24775 of file Messages.h.

◆ tail()

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

Definition at line 25086 of file Messages.h.

◆ toString()

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

Definition at line 1861 of file MessageSerialization.h.

◆ tradeDate()

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

◆ tradeId()

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