OnixS C++ ICE Binary Order Entry Handler 1.1.1
API Documentation
Loading...
Searching...
No Matches
SecurityDefinitionReport::SecurityAltIDEntry Struct Reference

Public Types

typedef SbeGroupEntry< GroupSizeEncoding::BlockLength > Base
typedef SecurityAltIDEntry ThisType
Public Types inherited from SbeGroupEntry< GroupSizeEncoding::BlockLength >
typedef GroupSizeEncoding::BlockLength BlockLength

Public Member Functions

 SecurityAltIDEntry (void *data, EncodedLength length, SchemaVersion version)
ThisType & resetVariableFields () noexcept
ThisType & reset () noexcept
auto securityAltId () const noexcept
ThisType & securityAltId (StrRef value) noexcept
ThisType & securityAltId (NullOpt) noexcept
auto securityAltIdSource () const noexcept
ThisType & securityAltIdSource (StrRef value) noexcept
ThisType & securityAltIdSource (NullOpt) noexcept
Public Member Functions inherited from SbeGroupEntry< GroupSizeEncoding::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 >
ONIXS_ICEBOE_FORCEINLINE Container & container () noexcept
void zeroPaddingBytes (BlockLength offset) noexcept
template<class FieldValue>
ONIXS_ICEBOE_FORCEINLINE void setOrdinary (BlockLength offset, FieldValue value) noexcept
template<class FieldValue>
ONIXS_ICEBOE_FORCEINLINE void setOrdinary (BlockLength offset, FieldValue value, SchemaVersion since)
template<class Enumeration>
ONIXS_ICEBOE_FORCEINLINE void setEnumeration (BlockLength offset, Enumeration value) noexcept
template<class Enumeration>
ONIXS_ICEBOE_FORCEINLINE void setEnumeration (BlockLength offset, Enumeration value, SchemaVersion since)
template<BlockLength Size>
ONIXS_ICEBOE_FORCEINLINE void setFixedStr (BlockLength offset, StrRef value) noexcept
template<BlockLength Size>
ONIXS_ICEBOE_FORCEINLINE 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<typename Value>
ONIXS_ICEBOE_FORCEINLINE Value ordinary (BlockLength offset) const noexcept
template<typename NullValue>
ONIXS_ICEBOE_FORCEINLINE std::enable_if<!isComposite< typenameNullValue::Value >::value, SbeOptional< typenameNullValue::Value, NullValue > >::type ordinary (BlockLength offset, OptionalTag) const noexcept
template<typename NullValue>
ONIXS_ICEBOE_FORCEINLINE std::enable_if<!isComposite< typenameNullValue::Value >::value, SbeOptional< typenameNullValue::Value, NullValue > >::type ordinary (BlockLength offset, SchemaVersion since, OptionalTag) const noexcept
template<typename NullValue>
ONIXS_ICEBOE_FORCEINLINE std::enable_if< isComposite< typenameNullValue::Value >::value, SbeOptional< typenameNullValue::Value, NullValue > >::type ordinary (BlockLength offset, OptionalTag) const noexcept
template<typename NullValue>
ONIXS_ICEBOE_FORCEINLINE std::enable_if< isComposite< typenameNullValue::Value >::value, SbeOptional< typenameNullValue::Value, NullValue > >::type ordinary (BlockLength offset, SchemaVersion since, OptionalTag) const noexcept
template<typename Enumeration>
ONIXS_ICEBOE_FORCEINLINE Enumeration enumeration (BlockLength offset) const noexcept
template<typename Enumeration, typename NullValue>
ONIXS_ICEBOE_FORCEINLINE SbeOptionalEnumeration< Enumeration, NullValue > enumeration (BlockLength offset, OptionalTag) const noexcept
template<typename Enumeration, typename NullValue>
ONIXS_ICEBOE_FORCEINLINE SbeOptionalEnumeration< Enumeration, NullValue > enumeration (BlockLength offset, SchemaVersion since, OptionalTag) const noexcept
template<BlockLength Length>
ONIXS_ICEBOE_FORCEINLINE StrRef fixedStr (BlockLength offset) const noexcept
template<BlockLength Length>
ONIXS_ICEBOE_FORCEINLINE SbeOptionalStr fixedStr (BlockLength offset, OptionalTag) const noexcept
template<BlockLength Length>
ONIXS_ICEBOE_FORCEINLINE SbeOptionalStr fixedStr (BlockLength offset, SchemaVersion since, OptionalTag) const noexcept
template<typename Value>
ONIXS_ICEBOE_FORCEINLINE Value decimal (BlockLength offset) const noexcept
template<typename NullValue>
SbeOptional< typename NullValue::Value, NullValue > ONIXS_ICEBOE_FORCEINLINE decimal (BlockLength offset, OptionalTag) const noexcept
template<typename NullValue>
ONIXS_ICEBOE_FORCEINLINE SbeOptional< typename NullValue::Value, NullValue > decimal (BlockLength offset, SchemaVersion since, OptionalTag) const noexcept
template<typename NullValue, typename Callable>
ONIXS_ICEBOE_FORCEINLINE std::enable_if<!isComposite< typenameNullValue::Value >::value, SbeOptionalConverted< decltype(std::declval< Callable >()(std::declval< typenameArgType< Callable >::type >()))> >::type convertible (BlockLength offset, OptionalTag) const noexcept(noexcept(Callable::Nothrow))
template<typename Callable>
ONIXS_ICEBOE_FORCEINLINE auto convertible (BlockLength offset) const noexcept(noexcept(Callable::Nothrow)) -> decltype(std::declval< Callable >()(std::declval< typename ArgType< Callable >::type >()))
Protected Member Functions inherited from BinaryBlockBase
 ~BinaryBlockBase ()=default

Detailed Description

Entry of SecurityAltIDEntry repeating group.

Definition at line 4389 of file Messages.h.

Member Typedef Documentation

◆ Base

typedef SbeGroupEntry< GroupSizeEncoding::BlockLength > Base

Base class type.

Definition at line 4401 of file Messages.h.

◆ ThisType

typedef SecurityAltIDEntry ThisType

This type alias.

Definition at line 4404 of file Messages.h.

Constructor & Destructor Documentation

◆ SecurityAltIDEntry()

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

Initializes instance of given version over given memory block.

Definition at line 4408 of file Messages.h.

4409 : Base(data, numericCast<Base::BlockLength>(length), version)
4410 {
4411 assert(version >= Schema::MinimalVersion);
4412 assert(length >= minimalBlockLength(version));
4413 }

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 4492 of file Messages.h.

4493 {
4494 return
4495 ONIXS_ICEBOE_ASSERT(version >= Schema::MinimalVersion),
4496 minimalBlockLength(version);
4497 }

◆ className()

constexpr StrRef className ( )
inlinestaticconstexprnoexcept

Entity class name.

Definition at line 4512 of file Messages.h.

4513 {
4514 return constructStrRef("SecurityDefinitionReport.SecurityAltIDEntry");
4515 }
OnixS::ICE::BOE::Messaging::constructStrRef
constexpr StrRef constructStrRef(const char(&value)[Size]) noexcept
Definition StrRef.h:414

◆ minimalBlockLength()

constexpr BlockLength minimalBlockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept
Returns
minimal size of entry body in bytes for given version of message template.

Definition at line 4502 of file Messages.h.

4503 {
4504 return
4505 ONIXS_ICEBOE_ASSERT(version >= Schema::MinimalVersion),
4506 33;
4507 }

◆ reset()

ThisType & reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 4422 of file Messages.h.

4423 {
4424 securityAltId(nullOpt);
4425 securityAltIdSource(nullOpt);
4426
4427 resetVariableFields();
4428 return *this;
4429 }

◆ resetVariableFields()

ThisType & resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

Definition at line 4416 of file Messages.h.

4417 {
4418 return *this;
4419 }

◆ securityAltId() [1/3]

auto securityAltId ( ) const
inlinenoexcept

Provides access to securityAltID field.

Definition at line 4433 of file Messages.h.

4434 {
4435 constexpr BlockLength offset = 0;
4436 constexpr BlockLength length = 30;
4437
4438 return fixedStr<length>(offset, optional);
4439 }

◆ securityAltId() [2/3]

ThisType & securityAltId ( NullOpt )
inlinenoexcept

Definition at line 4451 of file Messages.h.

4452 {
4453 constexpr BlockLength offset = 0;
4454 constexpr BlockLength length = 30;
4455
4456 setFixedStr<length>(offset, StrRef());
4457 return *this;
4458 }
OnixS::ICE::BOE::Messaging::StrRef
std::basic_string_view< Char > StrRef
Definition StrRef.h:46

◆ securityAltId() [3/3]

ThisType & securityAltId ( StrRef value)
inlinenoexcept

Provides access to securityAltID field.

Definition at line 4442 of file Messages.h.

4443 {
4444 constexpr BlockLength offset = 0;
4445 constexpr BlockLength length = 30;
4446
4447 setFixedStr<length>(offset, value);
4448 return *this;
4449 }

◆ securityAltIdSource() [1/3]

auto securityAltIdSource ( ) const
inlinenoexcept

Provides access to securityAltIDSource field.

Definition at line 4462 of file Messages.h.

4463 {
4464 constexpr BlockLength offset = 30;
4465 constexpr BlockLength length = 3;
4466
4467 return fixedStr<length>(offset, optional);
4468 }

◆ securityAltIdSource() [2/3]

ThisType & securityAltIdSource ( NullOpt )
inlinenoexcept

Definition at line 4480 of file Messages.h.

4481 {
4482 constexpr BlockLength offset = 30;
4483 constexpr BlockLength length = 3;
4484
4485 setFixedStr<length>(offset, StrRef());
4486 return *this;
4487 }

◆ securityAltIdSource() [3/3]

ThisType & securityAltIdSource ( StrRef value)
inlinenoexcept

Provides access to securityAltIDSource field.

Definition at line 4471 of file Messages.h.

4472 {
4473 constexpr BlockLength offset = 30;
4474 constexpr BlockLength length = 3;
4475
4476 setFixedStr<length>(offset, value);
4477 return *this;
4478 }