OnixS C++ CME iLink 3 Binary Order Entry Handler  1.17.0
API Documentation
PartyDetailsDefinitionRequest518::PartyDetailsEntry Struct Reference

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

Public Types

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

Public Member Functions

 PartyDetailsEntry (void *data, EncodedLength length, SchemaVersion version)
 
ThisTyperesetVariableFields () noexcept
 
ThisTypereset () noexcept
 
StrRef partyDetailId () const noexcept
 
ThisTypesetPartyDetailId (StrRef value) noexcept
 
PartyDetailRole::Enum partyDetailRole () const noexcept
 
ThisTypesetPartyDetailRole (PartyDetailRole::Enum 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 PartyIDSource partyDetailIdSource () 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< 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

More than one occurrence of the same party role is not allowed and will be rejected. Entry of PartyDetailsEntry repeating group.

Definition at line 8290 of file Messages.h.

Member Typedef Documentation

Base class type.

Definition at line 8302 of file Messages.h.

This type alias.

Definition at line 8305 of file Messages.h.

Constructor & Destructor Documentation

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

Initializes instance of given version over given memory block.

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

static constexpr const Char* className ( )
inlinestatic

Entity class name.

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

StrRef partyDetailId ( ) const
inlinenoexcept

The identification of the party.

Required when NoPartyDetails(1671) > 0.

Definition at line 8337 of file Messages.h.

static constexpr PartyIDSource partyDetailIdSource ( )
inlinestaticnoexcept

Used to identify source of PartyDetailID value.

Required when NoPartyDetails(1671) greater than 0. Constant value of C.

Definition at line 8363 of file Messages.h.

PartyDetailRole::Enum partyDetailRole ( ) const
inlinenoexcept

Identifies the type of PartyDetailID.

Required when NoPartyDetails(1671) > 0.

Definition at line 8372 of file Messages.h.

ThisType& reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 8327 of file Messages.h.

ThisType& resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

Definition at line 8320 of file Messages.h.

ThisType& setPartyDetailId ( StrRef  value)
inlinenoexcept

The identification of the party.

Required when NoPartyDetails(1671) > 0.

Definition at line 8348 of file Messages.h.

ThisType& setPartyDetailRole ( PartyDetailRole::Enum  value)
inlinenoexcept

Identifies the type of PartyDetailID.

Required when NoPartyDetails(1671) > 0.

Definition at line 8383 of file Messages.h.


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