OnixS C++ CME iLink 3 Binary Order Entry Handler  1.18.2
API Documentation
PartyDetailsListRequest537::RequestingPartyIDsEntry Struct Reference

#include <OnixS/CME/iLink3/messaging/Messages.h>

Public Types

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

Public Member Functions

 RequestingPartyIDsEntry (void *data, EncodedLength length, SchemaVersion version)
 
ThisTyperesetVariableFields () noexcept
 
ThisTypereset () noexcept
 
bool requestingPartyId (StrRef &value) const noexcept
 
ThisTypesetRequestingPartyId (StrRef value) noexcept
 
ThisTypesetRequestingPartyIdToNull () noexcept
 
CHAR requestingPartyIdSource () const noexcept
 
ThisTypesetRequestingPartyIdSource (CHAR value) noexcept
 
CHAR requestingPartyRole () const noexcept
 
ThisTypesetRequestingPartyRole (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< SbeGroupEntry< GroupSize::BlockLength >, GroupSize::BlockLength >
SbeGroupEntry< GroupSize::BlockLength > & container () noexcept
 
void zeroPaddingBytes (GroupSize::BlockLengthoffset) noexcept
 
void setOrdinary (GroupSize::BlockLengthoffset, FieldValue value) noexcept
 
void setOrdinary (GroupSize::BlockLengthoffset, FieldValue value, SchemaVersion since)
 
void setEnumeration (GroupSize::BlockLengthoffset, typename Enumeration::Enum value) noexcept
 
void setEnumeration (GroupSize::BlockLengthoffset, typename Enumeration::Enum value, SchemaVersion since)
 
void setFixedStr (GroupSize::BlockLengthoffset, StrRef value) noexcept
 
void setFixedStr (GroupSize::BlockLengthoffset, 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 CharclassName ()
 

Additional Inherited Members

- Protected Member Functions inherited from SbeFields< SbeGroupEntry< GroupSize::BlockLength >, GroupSize::BlockLength >
 SbeFields ()=default
 
 ~SbeFields ()=default
 
- Protected Member Functions inherited from BinaryBlock< SbeGroupEntry< GroupSize::BlockLength >, GroupSize::BlockLength >
 BinaryBlock ()=default
 
 ~BinaryBlock ()=default
 
Value ordinary (GroupSize::BlockLengthoffset) const noexcept
 
bool ordinary (Value &value, GroupSize::BlockLengthoffset, NullValue null) const noexcept
 
bool ordinary (Value &value, GroupSize::BlockLengthoffset, NullValue null, SchemaVersion since) const noexcept
 
Enumeration::Enum enumeration (GroupSize::BlockLengthoffset) const noexcept
 
bool enumeration (typename Enumeration::Enum &value, GroupSize::BlockLengthoffset, NullValue null) const noexcept
 
bool enumeration (typename Enumeration::Enum &value, GroupSize::BlockLengthoffset, NullValue null, SchemaVersion since) const noexcept
 
Value decimal (GroupSize::BlockLengthoffset) const noexcept
 
bool decimal (Value &value, GroupSize::BlockLengthoffset, NullValue null) const noexcept
 
bool decimal (Value &value, GroupSize::BlockLengthoffset, NullValue null, SchemaVersion since) const noexcept
 
StrRef fixedStr (GroupSize::BlockLengthoffset) const noexcept
 
bool fixedStr (StrRef &value, GroupSize::BlockLengthoffset) const noexcept
 
bool fixedStr (StrRef &value, GroupSize::BlockLengthoffset, 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 30080 of file Messages.h.

Member Typedef Documentation

Base class type.

Definition at line 30092 of file Messages.h.

This type alias.

Definition at line 30095 of file Messages.h.

Constructor & Destructor Documentation

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

Initializes instance of given version over given memory block.

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

static constexpr const Char* className ( )
inlinestatic

Entity class name.

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

bool requestingPartyId ( StrRef value) const
inlinenoexcept

Party identifier for the requesting party.

Required when NoRequestingPartyIDs(1657) > 0.

Definition at line 30129 of file Messages.h.

CHAR requestingPartyIdSource ( ) const
inlinenoexcept

Identifies the source of the RequestingPartyID(1658) value.

Required when NoRequestingPartyIDs(1657) > 0. Constant value.

Definition at line 30164 of file Messages.h.

CHAR requestingPartyRole ( ) const
inlinenoexcept

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

Constant value.

Definition at line 30187 of file Messages.h.

ThisType& reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 30117 of file Messages.h.

ThisType& resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

Definition at line 30110 of file Messages.h.

ThisType& setRequestingPartyId ( StrRef  value)
inlinenoexcept

Party identifier for the requesting party.

Required when NoRequestingPartyIDs(1657) > 0.

Definition at line 30140 of file Messages.h.

ThisType& setRequestingPartyIdSource ( CHAR  value)
inlinenoexcept

Identifies the source of the RequestingPartyID(1658) value.

Required when NoRequestingPartyIDs(1657) > 0. Constant value.

Definition at line 30175 of file Messages.h.

ThisType& setRequestingPartyIdToNull ( )
inlinenoexcept

Definition at line 30150 of file Messages.h.

ThisType& setRequestingPartyRole ( CHAR  value)
inlinenoexcept

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

Constant value.

Definition at line 30197 of file Messages.h.


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