OnixS C++ CME iLink 3 Binary Order Entry Handler 1.19.0
API Documentation
Loading...
Searching...
No Matches
PartyDetailsListRequest537::RequestingPartyIDsEntry Struct Reference

Public Types

typedef SbeGroupEntry< GroupSize::BlockLength > Base
typedef RequestingPartyIDsEntry ThisType
Public Types inherited from SbeGroupEntry< GroupSize::BlockLength >
typedef GroupSize::BlockLength BlockLength

Public Member Functions

 RequestingPartyIDsEntry (void *data, EncodedLength length, SchemaVersion version)
ThisType & resetVariableFields () noexcept
ThisType & reset () noexcept
bool requestingPartyId (StrRef &value) const noexcept
ThisType & setRequestingPartyId (StrRef value) noexcept
ThisType & setRequestingPartyIdToNull () noexcept
CHAR requestingPartyIdSource () const noexcept
ThisType & setRequestingPartyIdSource (CHAR value) noexcept
CHAR requestingPartyRole () const noexcept
ThisType & setRequestingPartyRole (CHAR value) noexcept
Public Member Functions inherited from SbeGroupEntry< GroupSize::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 StrRef className () noexcept

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>
Value ordinary (BlockLength offset, SchemaVersion since) const
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

Will be zero if specific PartyDetailsDefinitionID's are being requested. Will be populated only if all PartyDetailsDefinitions are being requested for a specific Firm. Entry of RequestingPartyIDsEntry repeating group.

Definition at line 28127 of file Messages.h.

Member Typedef Documentation

◆ Base

typedef SbeGroupEntry< GroupSize::BlockLength > Base

Base class type.

Definition at line 28139 of file Messages.h.

◆ ThisType

typedef RequestingPartyIDsEntry ThisType

This type alias.

Definition at line 28142 of file Messages.h.

Constructor & Destructor Documentation

◆ RequestingPartyIDsEntry()

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

Initializes instance of given version over given memory block.

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

◆ className()

constexpr StrRef className ( )
inlinestaticconstexprnoexcept

Entity class name.

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

◆ requestingPartyId()

bool requestingPartyId ( StrRef & value) const
inlinenoexcept

Party identifier for the requesting party.

Required when NoRequestingPartyIDs(1657) is greater than 0.

Definition at line 28174 of file Messages.h.

◆ requestingPartyIdSource()

CHAR requestingPartyIdSource ( ) const
inlinenoexcept

Identifies the source of the RequestingPartyID(1658) value.

Required when NoRequestingPartyIDs(1657) is greater than 0. Constant value.

Definition at line 28206 of file Messages.h.

◆ requestingPartyRole()

CHAR requestingPartyRole ( ) const
inlinenoexcept

Identifies the type or role of the RequestingPartyID(1658) specified.

Constant value.

Definition at line 28227 of file Messages.h.

◆ reset()

ThisType & reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 28163 of file Messages.h.

◆ resetVariableFields()

ThisType & resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

Definition at line 28157 of file Messages.h.

◆ setRequestingPartyId()

ThisType & setRequestingPartyId ( StrRef value)
inlinenoexcept

Party identifier for the requesting party.

Required when NoRequestingPartyIDs(1657) is greater than 0.

Definition at line 28184 of file Messages.h.

◆ setRequestingPartyIdSource()

ThisType & setRequestingPartyIdSource ( CHAR value)
inlinenoexcept

Identifies the source of the RequestingPartyID(1658) value.

Required when NoRequestingPartyIDs(1657) is greater than 0. Constant value.

Definition at line 28216 of file Messages.h.

◆ setRequestingPartyIdToNull()

ThisType & setRequestingPartyIdToNull ( )
inlinenoexcept

Definition at line 28193 of file Messages.h.

◆ setRequestingPartyRole()

ThisType & setRequestingPartyRole ( CHAR value)
inlinenoexcept

Identifies the type or role of the RequestingPartyID(1658) specified.

Constant value.

Definition at line 28236 of file Messages.h.