OnixS C++ CME iLink 3 Binary Order Entry Handler 1.18.9
API Documentation
Loading...
Searching...
No Matches
PartyDetailsListReport538::PartyDetailsEntry Struct Reference

Public Types

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

Public Member Functions

 PartyDetailsEntry (void *data, EncodedLength length, SchemaVersion version)
ThisType & resetVariableFields () noexcept
ThisType & reset () noexcept
StrRef partyDetailId () const noexcept
ThisType & setPartyDetailId (StrRef value) noexcept
PartyDetailRole::Enum partyDetailRole () const noexcept
ThisType & setPartyDetailRole (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< 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 PartyIDSource partyDetailIdSource () noexcept
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, 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

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

Definition at line 30834 of file Messages.h.

Member Typedef Documentation

◆ Base

typedef SbeGroupEntry< GroupSize::BlockLength > Base

Base class type.

Definition at line 30846 of file Messages.h.

◆ ThisType

typedef PartyDetailsEntry ThisType

This type alias.

Definition at line 30849 of file Messages.h.

Constructor & Destructor Documentation

◆ PartyDetailsEntry()

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

Initializes instance of given version over given memory block.

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

◆ className()

constexpr const Char * className ( )
inlinestaticconstexpr

Entity class name.

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

◆ partyDetailId()

StrRef partyDetailId ( ) const
inlinenoexcept

The identification of the party.

Required when NoPartyDetails(1671) > 0.

Definition at line 30881 of file Messages.h.

◆ partyDetailIdSource()

constexpr PartyIDSource partyDetailIdSource ( )
inlinestaticconstexprnoexcept

Used to identify source of PartyDetailID value.

Required when NoPartyDetails(1671) > 0. Constant value of "C".

Definition at line 30906 of file Messages.h.

◆ partyDetailRole()

PartyDetailRole::Enum partyDetailRole ( ) const
inlinenoexcept

Identifies the type of PartyDetailID.

Required when NoPartyDetails(1671) > 0.

Definition at line 30915 of file Messages.h.

◆ reset()

ThisType & reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 30871 of file Messages.h.

◆ resetVariableFields()

ThisType & resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

Definition at line 30864 of file Messages.h.

◆ setPartyDetailId()

ThisType & setPartyDetailId ( StrRef value)
inlinenoexcept

The identification of the party.

Required when NoPartyDetails(1671) > 0.

Definition at line 30892 of file Messages.h.

◆ setPartyDetailRole()

ThisType & setPartyDetailRole ( PartyDetailRole::Enum value)
inlinenoexcept

Identifies the type of PartyDetailID.

Required when NoPartyDetails(1671) > 0.

Definition at line 30926 of file Messages.h.