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

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< Container, BlockLength >
Container & container () noexcept
void zeroPaddingBytes (BlockLength offset) noexcept
template<class FieldValue>
void setOrdinary (BlockLength offset, FieldValue value) noexcept
template<class FieldValue>
void setOrdinary (BlockLength offset, FieldValue value, SchemaVersion since)
template<class Enumeration>
void setEnumeration (BlockLength offset, typename Enumeration::Enum value) noexcept
template<class Enumeration>
void setEnumeration (BlockLength offset, typename Enumeration::Enum value, SchemaVersion since)
template<BlockLength Size>
void setFixedStr (BlockLength offset, StrRef value) noexcept
template<BlockLength Size>
void setFixedStr (BlockLength offset, 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< Container, BlockLength >
 SbeFields ()=default
 ~SbeFields ()=default
Protected Member Functions inherited from BinaryBlock< Container, BlockLength >
 BinaryBlock ()=default
 ~BinaryBlock ()=default
template<class Value>
Value ordinary (BlockLength offset) const noexcept
template<class Value>
const Value & accessOrdinary (BlockLength offset) const noexcept
template<class Value>
Value & accessOrdinary (BlockLength offset) noexcept
template<class Value, class NullValue>
bool ordinary (Value &value, BlockLength offset, NullValue null) const noexcept
template<class Value, class NullValue>
bool ordinary (Value &value, BlockLength offset, NullValue null, SchemaVersion since) const noexcept
template<class Enumeration>
Enumeration::Enum enumeration (BlockLength offset) const noexcept
template<class Enumeration, class NullValue>
bool enumeration (typename Enumeration::Enum &value, BlockLength offset, NullValue null) const noexcept
template<class Enumeration, class NullValue>
bool enumeration (typename Enumeration::Enum &value, BlockLength offset, NullValue null, SchemaVersion since) const noexcept
template<class Value>
Value decimal (BlockLength offset) const noexcept
template<class Value, class NullValue>
bool decimal (Value &value, BlockLength offset, NullValue null) const noexcept
template<class Value, class NullValue>
bool decimal (Value &value, BlockLength offset, NullValue null, SchemaVersion since) const noexcept
template<BlockLength Length>
StrRef fixedStr (BlockLength offset) const noexcept
template<BlockLength Length>
bool fixedStr (StrRef &value, BlockLength offset) const noexcept
template<BlockLength Length>
bool fixedStr (StrRef &value, BlockLength offset, SchemaVersion since) const noexcept

Detailed Description

Entry of LegsEntry repeating group.

Definition at line 17016 of file Messages.h.

Member Typedef Documentation

◆ Base

Base class type.

Definition at line 17028 of file Messages.h.

◆ ThisType

This type alias.

Definition at line 17031 of file Messages.h.

Constructor & Destructor Documentation

◆ LegsEntry()

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

Initializes instance of given version over given memory block.

Definition at line 17035 of file Messages.h.

Member Function Documentation

◆ blockLength()

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

Definition at line 17155 of file Messages.h.

◆ className()

constexpr const Char * className ( )
inlinestaticconstexpr

Entity class name.

Definition at line 17183 of file Messages.h.

◆ legRatioQty()

RatioQty legRatioQty ( ) const
inlinenoexcept

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

Definition at line 17099 of file Messages.h.

◆ legSecurityExchange()

constexpr StrRef legSecurityExchange ( )
inlinestaticconstexprnoexcept

Exchange code the leg security belongs to.

Definition at line 17090 of file Messages.h.

◆ legSide()

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

◆ legSymbol()

StrRef legSymbol ( ) const
inlinenoexcept

Multileg instrument's individual security’s Symbol.

See Symbol (55) field for description.

Definition at line 17065 of file Messages.h.

◆ minimalBlockLength()

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

Definition at line 17170 of file Messages.h.

◆ reset()

ThisType & reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 17053 of file Messages.h.

◆ resetVariableFields()

ThisType & resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

Definition at line 17046 of file Messages.h.

◆ setLegRatioQty()

ThisType & setLegRatioQty ( RatioQty value)
inlinenoexcept

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

Definition at line 17109 of file Messages.h.

◆ setLegSide()

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

◆ setLegSideToNull()

ThisType & setLegSideToNull ( )
inlinenoexcept

Definition at line 17140 of file Messages.h.

◆ setLegSymbol()

ThisType & setLegSymbol ( StrRef value)
inlinenoexcept

Multileg instrument's individual security’s Symbol.

See Symbol (55) field for description.

Definition at line 17076 of file Messages.h.