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

Public Types

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

Member Typedef Documentation

◆ Schema

Used template schema.

Definition at line 25189 of file Messages.h.

◆ ThisType

This type alias.

Definition at line 25192 of file Messages.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId 602 

Definition at line 25195 of file Messages.h.

Constructor & Destructor Documentation

◆ AllocationReport602() [1/6]

AllocationReport602 ( )
default

Initializes a blank instance.

◆ AllocationReport602() [2/6]

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

Initializes an instance over the given memory block.

Definition at line 25201 of file Messages.h.

◆ AllocationReport602() [3/6]

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

◆ AllocationReport602() [4/6]

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

Creates an instance over the given memory block.

Definition at line 25230 of file Messages.h.

◆ AllocationReport602() [5/6]

AllocationReport602 ( const SbeMessage & message)
inlineexplicit

Creates an instance over the given SBE message.

Definition at line 25241 of file Messages.h.

◆ AllocationReport602() [6/6]

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

Creates an instance over the given memory block.

Performs no checks.

Definition at line 25252 of file Messages.h.

Member Function Documentation

◆ allocId()

AllocID allocId ( ) const
inlinenoexcept

Unique identifier for this allocation instruction message.

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

◆ allocRejCode()

bool allocRejCode ( RejReasonOptional & value) const
inlinenoexcept

Identifies reason for rejection.

Definition at line 25448 of file Messages.h.

◆ allocReportId()

AllocReportID allocReportId ( ) const
inlinenoexcept

Unique identifier for this message.

Definition at line 25358 of file Messages.h.

◆ allocReportType()

AllocReportType::Enum allocReportType ( ) const
inlinenoexcept

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

Definition at line 25401 of file Messages.h.

◆ allocStatus()

AllocStatus::Enum allocStatus ( ) const
inlinenoexcept

Identifies status of allocation.

Definition at line 25497 of file Messages.h.

◆ allocTransType()

AllocTransType::Enum allocTransType ( ) const
inlinenoexcept

Identifies allocation transaction type.

Definition at line 25378 of file Messages.h.

◆ blockLength()

constexpr BlockLength blockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept

Size of message body in bytes.

Definition at line 25656 of file Messages.h.

◆ businessHeader() [1/2]

const OutboundBusinessHeader & businessHeader ( ) const
inlinenoexcept

Message type = AllocationReport.

Common header to all inbound business messages.

Definition at line 25279 of file Messages.h.

◆ businessHeader() [2/2]

OutboundBusinessHeader & businessHeader ( )
inlinenoexcept

Common header to all inbound business messages.

Definition at line 25288 of file Messages.h.

◆ calculateBinarySize()

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

Definition at line 25746 of file Messages.h.

◆ className()

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

Definition at line 25712 of file Messages.h.

◆ enteringTrader()

StrRef enteringTrader ( ) const
inlinenoexcept

Identifies the trader who is inserting an order.

Definition at line 25619 of file Messages.h.

◆ fixType()

constexpr StrRef fixType ( )
inlinestaticconstexprnoexcept

FIX message type.

Definition at line 25721 of file Messages.h.

◆ getMaxMessageSize()

constexpr UInt64 getMaxMessageSize ( UInt8 )
inlinestaticconstexprnoexcept

Maximal message size.

Definition at line 25682 of file Messages.h.

◆ getMinimalVariableFieldsSize()

constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion version)
inlinestaticconstexpr

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

Definition at line 25670 of file Messages.h.

◆ messageType()

constexpr MessageType::Enum messageType ( )
inlinestaticconstexprnoexcept

Message type = AllocationReport.

Definition at line 25268 of file Messages.h.

◆ minimalBlockLength()

constexpr BlockLength minimalBlockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept

Minimal size of message body in bytes.

Definition at line 25644 of file Messages.h.

◆ quantity()

Quantity quantity ( ) const
inlinenoexcept

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

Definition at line 25477 of file Messages.h.

◆ reset()

ThisType & reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 25698 of file Messages.h.

◆ resetVariableFields()

ThisType & resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

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

◆ securityId()

SecurityID securityId ( ) const
inlinenoexcept

Security identification as defined by exchange.

Definition at line 25317 of file Messages.h.

◆ securityIdSource()

constexpr SecurityIDSource::Enum securityIdSource ( )
inlinestaticconstexprnoexcept

Identifies the class of the SecurityID (Exchange Symbol).

Definition at line 25338 of file Messages.h.

◆ senderLocation()

StrRef senderLocation ( ) const
inlinenoexcept

Identifies the original location for routing orders.

Definition at line 25597 of file Messages.h.

◆ setAllocId()

ThisType & setAllocId ( AllocID value)
inlinenoexcept

Unique identifier for this allocation instruction message.

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

◆ setAllocRejCode()

ThisType & setAllocRejCode ( RejReasonOptional value)
inlinenoexcept

Identifies reason for rejection.

Definition at line 25457 of file Messages.h.

◆ setAllocRejCodeToNull()

ThisType & setAllocRejCodeToNull ( )
inlinenoexcept

Definition at line 25466 of file Messages.h.

◆ setAllocReportId()

ThisType & setAllocReportId ( AllocReportID value)
inlinenoexcept

Unique identifier for this message.

Definition at line 25367 of file Messages.h.

◆ setAllocReportType()

ThisType & setAllocReportType ( AllocReportType::Enum value)
inlinenoexcept

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

Definition at line 25412 of file Messages.h.

◆ setAllocStatus()

ThisType & setAllocStatus ( AllocStatus::Enum value)
inlinenoexcept

Identifies status of allocation.

Definition at line 25506 of file Messages.h.

◆ setAllocTransType()

ThisType & setAllocTransType ( AllocTransType::Enum value)
inlinenoexcept

Identifies allocation transaction type.

Definition at line 25388 of file Messages.h.

◆ setEnteringTrader()

ThisType & setEnteringTrader ( StrRef value)
inlinenoexcept

Identifies the trader who is inserting an order.

Definition at line 25629 of file Messages.h.

◆ setQuantity()

ThisType & setQuantity ( Quantity value)
inlinenoexcept

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

Definition at line 25486 of file Messages.h.

◆ setSecurityId()

ThisType & setSecurityId ( SecurityID value)
inlinenoexcept

Security identification as defined by exchange.

Definition at line 25326 of file Messages.h.

◆ setSenderLocation()

ThisType & setSenderLocation ( StrRef value)
inlinenoexcept

Identifies the original location for routing orders.

Definition at line 25607 of file Messages.h.

◆ setSide()

ThisType & setSide ( Side::Enum value)
inlinenoexcept

Side of order.

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

◆ setTradeDateToNull()

ThisType & setTradeDateToNull ( )
inlinenoexcept

Definition at line 25546 of file Messages.h.

◆ setTransactTime()

ThisType & setTransactTime ( UTCTimestampNanos value)
inlinenoexcept

Time of execution/order creation.

Definition at line 25566 of file Messages.h.

◆ side()

Side::Enum side ( ) const
inlinenoexcept

Side of order.

Definition at line 25577 of file Messages.h.

◆ tail()

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

Definition at line 25733 of file Messages.h.

◆ toString()

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

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

◆ transactTime()

UTCTimestampNanos transactTime ( ) const
inlinenoexcept

Time of execution/order creation.

Definition at line 25557 of file Messages.h.