OnixS C++ B3 BOE Binary Order Entry 1.4.0
Users' manual and API documentation
Loading...
Searching...
No Matches
PositionMaintenanceReport503::PositionsEntry Struct Reference

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

Public Types

typedef SbeGroupEntry< GroupSizeEncoding::BlockLength > Base
typedef PositionsEntry ThisType
Public Types inherited from SbeGroupEntry< GroupSizeEncoding::BlockLength >
typedef GroupSizeEncoding::BlockLength BlockLength

Public Member Functions

 PositionsEntry (void *data, EncodedLength length, SchemaVersion version)
ThisType & resetVariableFields () noexcept
ThisType & reset () noexcept
void toString (std::string &dest, bool skipEmptyFields=false)
std::string toString (bool skipEmptyFields=false) const
PosType::Enum posType () const noexcept
ThisType & setPosType (PosType::Enum value) noexcept
bool longQty (QuantityOptional &value) const noexcept
ThisType & setLongQty (QuantityOptional value) noexcept
ThisType & setLongQtyToNull () noexcept
bool shortQty (QuantityOptional &value) const noexcept
ThisType & setShortQty (QuantityOptional value) noexcept
ThisType & setShortQtyToNull () 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 BlockLength blockLength (SchemaVersion version) noexcept
static constexpr BlockLength minimalBlockLength (SchemaVersion version) noexcept
static constexpr const Char * className ()

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

Repeating group dimensions. Entry of PositionsEntry repeating group.

Definition at line 23873 of file Messages.h.

Member Typedef Documentation

◆ Base

Base class type.

Definition at line 23885 of file Messages.h.

◆ ThisType

This type alias.

Definition at line 23888 of file Messages.h.

Constructor & Destructor Documentation

◆ PositionsEntry()

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

Initializes instance of given version over given memory block.

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

◆ className()

constexpr const Char * className ( )
inlinestaticconstexpr

Entity class name.

Definition at line 24042 of file Messages.h.

◆ longQty()

bool longQty ( QuantityOptional & value) const
inlinenoexcept

Long Quantity.

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

◆ posType()

PosType::Enum posType ( ) const
inlinenoexcept

Used to identify the type of quantity.

Definition at line 23935 of file Messages.h.

◆ reset()

ThisType & reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 23910 of file Messages.h.

◆ resetVariableFields()

ThisType & resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

Definition at line 23903 of file Messages.h.

◆ setLongQty()

ThisType & setLongQty ( QuantityOptional value)
inlinenoexcept

Long Quantity.

Definition at line 23964 of file Messages.h.

◆ setLongQtyToNull()

ThisType & setLongQtyToNull ( )
inlinenoexcept

Definition at line 23973 of file Messages.h.

◆ setPosType()

ThisType & setPosType ( PosType::Enum value)
inlinenoexcept

Used to identify the type of quantity.

Definition at line 23944 of file Messages.h.

◆ setShortQty()

ThisType & setShortQty ( QuantityOptional value)
inlinenoexcept

Short Quantity.

Definition at line 23993 of file Messages.h.

◆ setShortQtyToNull()

ThisType & setShortQtyToNull ( )
inlinenoexcept

Definition at line 24002 of file Messages.h.

◆ shortQty()

bool shortQty ( QuantityOptional & value) const
inlinenoexcept

Short Quantity.

Definition at line 23984 of file Messages.h.

◆ toString() [1/2]

std::string toString ( bool skipEmptyFields = false) const
inline
Returns
a human-readable presentation.

Definition at line 2447 of file MessageSerialization.h.

◆ toString() [2/2]

void toString ( std::string & dest,
bool skipEmptyFields = false )
inline

Writes a human-readable presentation into the destination string.

Definition at line 2440 of file MessageSerialization.h.