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

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

Public Types

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

Public Member Functions

 PartyIDsEntry (void *data, EncodedLength length, SchemaVersion version)
 
ThisTyperesetVariableFields () noexcept
 
ThisTypereset () noexcept
 
UInt64 partyId () const noexcept
 
ThisTypesetPartyId (UInt64 value) noexcept
 
CHAR partyIdSource () const noexcept
 
ThisTypesetPartyIdSource (CHAR value) noexcept
 
UInt16 partyRole () const noexcept
 
ThisTypesetPartyRole (UInt16 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

Applicable only if specific PartyDetailsDefinitions are being requested otherwise set to 0. Entry of PartyIDsEntry repeating group.

Definition at line 30253 of file Messages.h.

Member Typedef Documentation

Base class type.

Definition at line 30265 of file Messages.h.

This type alias.

Definition at line 30268 of file Messages.h.

Constructor & Destructor Documentation

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

Initializes instance of given version over given memory block.

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

static constexpr const Char* className ( )
inlinestatic

Entity class name.

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

UInt64 partyId ( ) const
inlinenoexcept

Required if NoPartyIDs(453) > 0.

Identification of the PartyDetailsListRequestID of PartyDetailsDefinitionRequestAck.

Definition at line 30301 of file Messages.h.

CHAR partyIdSource ( ) const
inlinenoexcept

Required if NoPartyIDs(453) > 0.

Used to identify classification source. Constant value.

Definition at line 30324 of file Messages.h.

UInt16 partyRole ( ) const
inlinenoexcept

Required if NoPartyIDs(453) > 0.

Identifies the type of PartyID(448).

Definition at line 30346 of file Messages.h.

ThisType& reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 30290 of file Messages.h.

ThisType& resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

Definition at line 30283 of file Messages.h.

ThisType& setPartyId ( UInt64  value)
inlinenoexcept

Required if NoPartyIDs(453) > 0.

Identification of the PartyDetailsListRequestID of PartyDetailsDefinitionRequestAck.

Definition at line 30312 of file Messages.h.

ThisType& setPartyIdSource ( CHAR  value)
inlinenoexcept

Required if NoPartyIDs(453) > 0.

Used to identify classification source. Constant value.

Definition at line 30334 of file Messages.h.

ThisType& setPartyRole ( UInt16  value)
inlinenoexcept

Required if NoPartyIDs(453) > 0.

Identifies the type of PartyID(448).

Definition at line 30356 of file Messages.h.


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