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

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

Public Types

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

Public Member Functions

 AllocationReport602 ()=default
 
 AllocationReport602 (void *data, EncodedLength length, SchemaVersion version=Schema::Version)
 
 AllocationReport602 (void *data, EncodedLength length, NoFieldsInit, SchemaVersion version=Schema::Version)
 
 AllocationReport602 (void *data, EncodedLength length, NoInit)
 
 AllocationReport602 (const SbeMessage &message)
 
 AllocationReport602 (void *data, EncodedLength length, NoInit, NoCheck) noexcept
 
const OutboundBusinessHeaderbusinessHeader () const noexcept
 
OutboundBusinessHeaderbusinessHeader () noexcept
 
AllocID allocId () const noexcept
 
ThisTypesetAllocId (AllocID value) noexcept
 
SecurityID securityId () const noexcept
 
ThisTypesetSecurityId (SecurityID value) noexcept
 
AllocReportID allocReportId () const noexcept
 
ThisTypesetAllocReportId (AllocReportID value) noexcept
 
AllocTransType::Enum allocTransType () const noexcept
 
ThisTypesetAllocTransType (AllocTransType::Enum value) noexcept
 
AllocReportType::Enum allocReportType () const noexcept
 
ThisTypesetAllocReportType (AllocReportType::Enum value) noexcept
 
AllocNoOrdersType::Enum allocNoOrdersType () const noexcept
 
ThisTypesetAllocNoOrdersType (AllocNoOrdersType::Enum value) noexcept
 
bool allocRejCode (RejReasonOptional &value) const noexcept
 
ThisTypesetAllocRejCode (RejReasonOptional value) noexcept
 
ThisTypesetAllocRejCodeToNull () noexcept
 
Quantity quantity () const noexcept
 
ThisTypesetQuantity (Quantity value) noexcept
 
AllocStatus::Enum allocStatus () const noexcept
 
ThisTypesetAllocStatus (AllocStatus::Enum value) noexcept
 
bool tradeDate (Timestamp &value) const noexcept
 
ThisTypesetTradeDate (Timestamp value) noexcept
 
ThisTypesetTradeDateToNull () noexcept
 
UTCTimestampNanos transactTime () const noexcept
 
ThisTypesetTransactTime (UTCTimestampNanos value) noexcept
 
Side::Enum side () const noexcept
 
ThisTypesetSide (Side::Enum value) noexcept
 
StrRef senderLocation () const noexcept
 
ThisTypesetSenderLocation (StrRef value) noexcept
 
StrRef enteringTrader () const noexcept
 
ThisTypesetEnteringTrader (StrRef value) noexcept
 
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 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 24748 of file Messages.h.

Member Typedef Documentation

Used template schema.

Definition at line 24753 of file Messages.h.

This type alias.

Definition at line 24756 of file Messages.h.

Member Enumeration Documentation

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId 

Definition at line 24759 of file Messages.h.

Constructor & Destructor Documentation

AllocationReport602 ( )
default

Initializes a blank instance.

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

Initializes an instance over the given memory block.

Definition at line 24765 of file Messages.h.

AllocationReport602 ( 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 24780 of file Messages.h.

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

Creates an instance over the given memory block.

Definition at line 24794 of file Messages.h.

AllocationReport602 ( const SbeMessage message)
inlineexplicit

Creates an instance over the given SBE message.

Definition at line 24805 of file Messages.h.

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

Creates an instance over the given memory block.

Performs no checks.

Definition at line 24816 of file Messages.h.

Member Function Documentation

AllocID allocId ( ) const
inlinenoexcept

Unique identifier for this allocation instruction message.

Definition at line 24861 of file Messages.h.

AllocNoOrdersType::Enum allocNoOrdersType ( ) const
inlinenoexcept

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

Definition at line 24989 of file Messages.h.

bool allocRejCode ( RejReasonOptional value) const
inlinenoexcept

Identifies reason for rejection.

Definition at line 25012 of file Messages.h.

AllocReportID allocReportId ( ) const
inlinenoexcept

Unique identifier for this message.

Definition at line 24922 of file Messages.h.

AllocReportType::Enum allocReportType ( ) const
inlinenoexcept

Describes the specific type or purpose of an Allocation Report message.

Definition at line 24965 of file Messages.h.

AllocStatus::Enum allocStatus ( ) const
inlinenoexcept

Identifies status of allocation.

Definition at line 25061 of file Messages.h.

AllocTransType::Enum allocTransType ( ) const
inlinenoexcept

Identifies allocation transaction type.

Definition at line 24942 of file Messages.h.

static constexpr BlockLength blockLength ( SchemaVersion  version)
inlinestaticnoexcept

Size of message body in bytes.

Definition at line 25226 of file Messages.h.

const OutboundBusinessHeader& businessHeader ( ) const
inlinenoexcept

Message type = AllocationReport.

Common header to all inbound business messages.

Definition at line 24843 of file Messages.h.

OutboundBusinessHeader& businessHeader ( )
inlinenoexcept

Common header to all inbound business messages.

Definition at line 24852 of file Messages.h.

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

Definition at line 25316 of file Messages.h.

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

Definition at line 25282 of file Messages.h.

StrRef enteringTrader ( ) const
inlinenoexcept

Identifies the trader who is inserting an order.

Definition at line 25189 of file Messages.h.

static constexpr StrRef fixType ( )
inlinestaticnoexcept

FIX message type.

Definition at line 25291 of file Messages.h.

static constexpr UInt64 getMaxMessageSize ( UInt8  )
inlinestaticnoexcept

Maximal message size.

Definition at line 25252 of file Messages.h.

static constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion  version)
inlinestatic

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

Definition at line 25240 of file Messages.h.

static constexpr MessageType::Enum messageType ( )
inlinestaticnoexcept

Message type = AllocationReport.

Definition at line 24832 of file Messages.h.

static constexpr BlockLength minimalBlockLength ( SchemaVersion  version)
inlinestaticnoexcept

Minimal size of message body in bytes.

Definition at line 25214 of file Messages.h.

Quantity quantity ( ) const
inlinenoexcept

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

Definition at line 25041 of file Messages.h.

ThisType& reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 25268 of file Messages.h.

ThisType& resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

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

SecurityID securityId ( ) const
inlinenoexcept

Security identification as defined by exchange.

Definition at line 24881 of file Messages.h.

static constexpr SecurityIDSource::Enum securityIdSource ( )
inlinestaticnoexcept

Identifies the class of the SecurityID (Exchange Symbol).

Definition at line 24902 of file Messages.h.

StrRef senderLocation ( ) const
inlinenoexcept

Identifies the original location for routing orders.

Definition at line 25167 of file Messages.h.

ThisType& setAllocId ( AllocID  value)
inlinenoexcept

Unique identifier for this allocation instruction message.

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

ThisType& setAllocRejCode ( RejReasonOptional  value)
inlinenoexcept

Identifies reason for rejection.

Definition at line 25021 of file Messages.h.

ThisType& setAllocRejCodeToNull ( )
inlinenoexcept

Definition at line 25030 of file Messages.h.

ThisType& setAllocReportId ( AllocReportID  value)
inlinenoexcept

Unique identifier for this message.

Definition at line 24931 of file Messages.h.

ThisType& setAllocReportType ( AllocReportType::Enum  value)
inlinenoexcept

Describes the specific type or purpose of an Allocation Report message.

Definition at line 24976 of file Messages.h.

ThisType& setAllocStatus ( AllocStatus::Enum  value)
inlinenoexcept

Identifies status of allocation.

Definition at line 25070 of file Messages.h.

ThisType& setAllocTransType ( AllocTransType::Enum  value)
inlinenoexcept

Identifies allocation transaction type.

Definition at line 24952 of file Messages.h.

ThisType& setEnteringTrader ( StrRef  value)
inlinenoexcept

Identifies the trader who is inserting an order.

Definition at line 25199 of file Messages.h.

ThisType& setQuantity ( Quantity  value)
inlinenoexcept

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

Definition at line 25050 of file Messages.h.

ThisType& setSecurityId ( SecurityID  value)
inlinenoexcept

Security identification as defined by exchange.

Definition at line 24890 of file Messages.h.

ThisType& setSenderLocation ( StrRef  value)
inlinenoexcept

Identifies the original location for routing orders.

Definition at line 25177 of file Messages.h.

ThisType& setSide ( Side::Enum  value)
inlinenoexcept

Side of order.

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

ThisType& setTradeDateToNull ( )
inlinenoexcept

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

Side::Enum side ( ) const
inlinenoexcept

Side of order.

Definition at line 25147 of file Messages.h.

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

Definition at line 25303 of file Messages.h.

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

Definition at line 1908 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 25082 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 25124 of file Messages.h.


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