OnixS C++ ICE Binary Order Entry Handler 1.1.1
API Documentation
Loading...
Searching...
No Matches
SbeGroupEntry< BodySizeType > Class Template Reference

Public Types

typedef BodySizeType BlockLength

Public Member Functions

 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< BodySizeType >, BodySizeType >
ONIXS_ICEBOE_FORCEINLINE SbeGroupEntry< BodySizeType > & container () noexcept
void zeroPaddingBytes (BodySizeType offset) noexcept
ONIXS_ICEBOE_FORCEINLINE void setOrdinary (BodySizeType offset, FieldValue value) noexcept
ONIXS_ICEBOE_FORCEINLINE void setEnumeration (BodySizeType offset, Enumeration value) noexcept
ONIXS_ICEBOE_FORCEINLINE void setFixedStr (BodySizeType offset, StrRef value) noexcept

Additional Inherited Members

Protected Member Functions inherited from SbeFields< SbeGroupEntry< BodySizeType >, BodySizeType >
 SbeFields ()=default
 ~SbeFields ()=default
Protected Member Functions inherited from BinaryBlock< SbeGroupEntry< BodySizeType >, BodySizeType >
 BinaryBlock ()=default
 ~BinaryBlock ()=default
ONIXS_ICEBOE_FORCEINLINE Value ordinary (BodySizeType offset) const noexcept
ONIXS_ICEBOE_FORCEINLINE Enumeration enumeration (BodySizeType offset) const noexcept
ONIXS_ICEBOE_FORCEINLINE StrRef fixedStr (BodySizeType offset) const noexcept
ONIXS_ICEBOE_FORCEINLINE Value decimal (BodySizeType offset) const noexcept
ONIXS_ICEBOE_FORCEINLINE std::enable_if<!isComposite< typenameNullValue::Value >::value, SbeOptionalConverted< decltype(std::declval< Callable >()(std::declval< typenameArgType< Callable >::type >()))> >::type convertible (BodySizeType offset, OptionalTag) const noexcept(noexcept(Callable::Nothrow))
Protected Member Functions inherited from BinaryBlockBase
 ~BinaryBlockBase ()=default

Detailed Description

template<class BodySizeType>
class OnixS::ICE::BOE::Messaging::SbeGroupEntry< BodySizeType >

Definition at line 359 of file SbeMessage.h.

Member Typedef Documentation

◆ BlockLength

template<class BodySizeType>
typedef BodySizeType BlockLength

Type to present the length of binary data of the repeating group entry.

Definition at line 363 of file SbeMessage.h.

Constructor & Destructor Documentation

◆ SbeGroupEntry() [1/2]

template<class BodySizeType>
SbeGroupEntry ( )
inline

Initializes a blank instance.

Definition at line 366 of file SbeMessage.h.

367 : encoded_(nullptr)
368 , size_(0)
369 , version_(0)
370 {
371 }

◆ SbeGroupEntry() [2/2]

template<class BodySizeType>
SbeGroupEntry ( void * encoded,
BlockLength size,
SchemaVersion version )
inline

Initializes the instance from the memory block of the encoded message.

Definition at line 375 of file SbeMessage.h.

376 : encoded_(encoded)
377 , size_(size)
378 , version_(version)
379 {
380 assert(encoded);
381 }

Member Function Documentation

◆ block() [1/2]

template<class BodySizeType>
const void * block ( ) const
inlinenoexcept
Returns
the pointer to the block containing fixed-length fields.

Definition at line 406 of file SbeMessage.h.

407 {
408 assert(valid());
409
410 return encoded_;
411 }

◆ block() [2/2]

template<class BodySizeType>
void * block ( )
inlinenoexcept
Returns
the pointer to the block containing fixed-length fields.

Definition at line 414 of file SbeMessage.h.

415 {
416 assert(valid());
417
418 return encoded_;
419 }

◆ blockLength()

template<class BodySizeType>
BlockLength blockLength ( ) const
inlinenoexcept
Returns
Block length.

Definition at line 422 of file SbeMessage.h.

423 {
424 return size_;
425 }

◆ encoded() [1/2]

template<class BodySizeType>
const void * encoded ( ) const
inlinenoexcept
Returns
the beginning of the group entry body.

Definition at line 390 of file SbeMessage.h.

391 {
392 assert(valid());
393
394 return encoded_;
395 }

◆ encoded() [2/2]

template<class BodySizeType>
void * encoded ( )
inlinenoexcept
Returns
the beginning of the group entry body.

Definition at line 398 of file SbeMessage.h.

399 {
400 assert(valid());
401
402 return encoded_;
403 }

◆ valid()

template<class BodySizeType>
bool valid ( ) const
inlinenoexcept
Returns
true if the instance refers to a valid content, otherwise - false.

Definition at line 384 of file SbeMessage.h.

385 {
386 return (encoded_ != nullptr);
387 }

◆ version()

template<class BodySizeType>
SchemaVersion version ( ) const
inlinenoexcept
Returns
SBE Schema version.

Definition at line 428 of file SbeMessage.h.

429 {
430 return version_;
431 }