OnixS C++ B3 BOE Binary Order Entry  1.2.0
API Documentation
SecurityDefinitionRequest300::LegsEntry Struct Reference

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

Public Types

typedef SbeGroupEntry< GroupSizeEncoding::BlockLengthBase
 
typedef LegsEntry ThisType
 
- Public Types inherited from SbeGroupEntry< GroupSizeEncoding::BlockLength >
typedef GroupSizeEncoding::BlockLength BlockLength
 

Public Member Functions

 LegsEntry (void *data, EncodedLength length, SchemaVersion version)
 
ThisTyperesetVariableFields () noexcept
 
ThisTypereset () noexcept
 
StrRef legSymbol () const noexcept
 
ThisTypesetLegSymbol (StrRef value) noexcept
 
RatioQty legRatioQty () const noexcept
 
ThisTypesetLegRatioQty (RatioQty value) noexcept
 
bool legSide (Side::Enum &value) const noexcept
 
ThisTypesetLegSide (Side::Enum value) noexcept
 
ThisTypesetLegSideToNull () noexcept
 
- Public Member Functions inherited from SbeGroupEntry< GroupSizeEncoding::BlockLength >
 SbeGroupEntry ()
 
 SbeGroupEntry (void *encoded, BlockLength size, SchemaVersion version)
 
bool valid () const noexcept
 
const void * encoded () const noexcept
 
void * encoded () noexcept
 
const void * block () const noexcept
 
void * block () noexcept
 
BlockLength blockLength () const noexcept
 
SchemaVersion version () const noexcept
 
- Public Member Functions inherited from SbeFields< SbeGroupEntry< GroupSizeEncoding::BlockLength >, GroupSizeEncoding::BlockLength >
SbeGroupEntry< GroupSizeEncoding::BlockLength > & container () noexcept
 
void zeroPaddingBytes (GroupSizeEncoding::BlockLengthoffset) noexcept
 
void setOrdinary (GroupSizeEncoding::BlockLengthoffset, FieldValue value) noexcept
 
void setOrdinary (GroupSizeEncoding::BlockLengthoffset, FieldValue value, SchemaVersion since)
 
void setEnumeration (GroupSizeEncoding::BlockLengthoffset, typename Enumeration::Enum value) noexcept
 
void setEnumeration (GroupSizeEncoding::BlockLengthoffset, typename Enumeration::Enum value, SchemaVersion since)
 
void setFixedStr (GroupSizeEncoding::BlockLengthoffset, StrRef value) noexcept
 
void setFixedStr (GroupSizeEncoding::BlockLengthoffset, StrRef value, SchemaVersion since)
 

Static Public Member Functions

static constexpr StrRef legSecurityExchange () noexcept
 
static constexpr BlockLength blockLength (SchemaVersion version) noexcept
 
static constexpr BlockLength minimalBlockLength (SchemaVersion version) noexcept
 
static constexpr const CharclassName ()
 

Additional Inherited Members

- Protected Member Functions inherited from SbeFields< SbeGroupEntry< GroupSizeEncoding::BlockLength >, GroupSizeEncoding::BlockLength >
 SbeFields ()=default
 
 ~SbeFields ()=default
 
- Protected Member Functions inherited from BinaryBlock< SbeGroupEntry< GroupSizeEncoding::BlockLength >, GroupSizeEncoding::BlockLength >
 BinaryBlock ()=default
 
 ~BinaryBlock ()=default
 
Value ordinary (GroupSizeEncoding::BlockLengthoffset) const noexcept
 
bool ordinary (Value &value, GroupSizeEncoding::BlockLengthoffset, NullValue null) const noexcept
 
bool ordinary (Value &value, GroupSizeEncoding::BlockLengthoffset, NullValue null, SchemaVersion since) const noexcept
 
const Value & accessOrdinary (GroupSizeEncoding::BlockLengthoffset) const noexcept
 
Value & accessOrdinary (GroupSizeEncoding::BlockLengthoffset) noexcept
 
Enumeration::Enum enumeration (GroupSizeEncoding::BlockLengthoffset) const noexcept
 
bool enumeration (typename Enumeration::Enum &value, GroupSizeEncoding::BlockLengthoffset, NullValue null) const noexcept
 
bool enumeration (typename Enumeration::Enum &value, GroupSizeEncoding::BlockLengthoffset, NullValue null, SchemaVersion since) const noexcept
 
Value decimal (GroupSizeEncoding::BlockLengthoffset) const noexcept
 
bool decimal (Value &value, GroupSizeEncoding::BlockLengthoffset, NullValue null) const noexcept
 
bool decimal (Value &value, GroupSizeEncoding::BlockLengthoffset, NullValue null, SchemaVersion since) const noexcept
 
StrRef fixedStr (GroupSizeEncoding::BlockLengthoffset) const noexcept
 
bool fixedStr (StrRef &value, GroupSizeEncoding::BlockLengthoffset) const noexcept
 
bool fixedStr (StrRef &value, GroupSizeEncoding::BlockLengthoffset, SchemaVersion since) const noexcept
 

Detailed Description

Entry of LegsEntry repeating group.

Definition at line 16686 of file Messages.h.

Member Typedef Documentation

Base class type.

Definition at line 16698 of file Messages.h.

This type alias.

Definition at line 16701 of file Messages.h.

Constructor & Destructor Documentation

LegsEntry ( void *  data,
EncodedLength  length,
SchemaVersion  version 
)
inline

Initializes instance of given version over given memory block.

Definition at line 16705 of file Messages.h.

Member Function Documentation

static constexpr BlockLength blockLength ( SchemaVersion  version)
inlinestaticnoexcept
Returns
size of entry body in bytes for given version of message template.

Definition at line 16825 of file Messages.h.

static constexpr const Char* className ( )
inlinestatic

Entity class name.

Definition at line 16853 of file Messages.h.

RatioQty legRatioQty ( ) const
inlinenoexcept

The ratio of quantity for this individual leg relative to the entire multileg security.

Definition at line 16769 of file Messages.h.

static constexpr StrRef legSecurityExchange ( )
inlinestaticnoexcept

Exchange code the leg security belongs to.

Definition at line 16760 of file Messages.h.

bool legSide ( Side::Enum value) const
inlinenoexcept

The side of this individual leg (multileg security).

See Side (54) field for description and values.

Definition at line 16791 of file Messages.h.

StrRef legSymbol ( ) const
inlinenoexcept

Multileg instrument's individual security’s Symbol.

See Symbol (55) field for description.

Definition at line 16735 of file Messages.h.

static constexpr BlockLength minimalBlockLength ( SchemaVersion  version)
inlinestaticnoexcept
Returns
minimal size of entry body in bytes for given version of message template.

Definition at line 16840 of file Messages.h.

ThisType& reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 16723 of file Messages.h.

ThisType& resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

Definition at line 16716 of file Messages.h.

ThisType& setLegRatioQty ( RatioQty  value)
inlinenoexcept

The ratio of quantity for this individual leg relative to the entire multileg security.

Definition at line 16779 of file Messages.h.

ThisType& setLegSide ( Side::Enum  value)
inlinenoexcept

The side of this individual leg (multileg security).

See Side (54) field for description and values.

Definition at line 16801 of file Messages.h.

ThisType& setLegSideToNull ( )
inlinenoexcept

Definition at line 16810 of file Messages.h.

ThisType& setLegSymbol ( StrRef  value)
inlinenoexcept

Multileg instrument's individual security’s Symbol.

See Symbol (55) field for description.

Definition at line 16746 of file Messages.h.


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