SbeGroupEntries< EntryType, BlockLength, NumInGroup, Length > Class Template Reference

Classes
class	Iterator

Public Types
typedef Length	EncodedLength
typedef EntryType	Entry
typedef NumInGroup	Size

Public Member Functions
	SbeGroupEntries () noexcept
	SbeGroupEntries (void *encoded, BlockLength blockLength, Size groupSize, SchemaVersion version) noexcept
bool	valid () const noexcept
bool	empty () const noexcept
Size	size () const noexcept
Iterator	begin () const
Iterator	end () const
Entry	operator[] (Size index) const
void *	encoded () const noexcept
EncodedLength	encodedLength () const noexcept
template<class OtherEntry, class OtherBlockLength, class OtherNumInGroup, class OtherLength>
	SbeGroupEntries (const SbeGroupEntries< OtherEntry, OtherBlockLength, OtherNumInGroup, OtherLength > &other) noexcept
template<class OtherEntry, class OtherBlockLength, class OtherNumInGroup, class OtherLength>
SbeGroupEntries &	operator= (const SbeGroupEntries< OtherEntry, OtherBlockLength, OtherNumInGroup, OtherLength > &other) noexcept

Friends
template<class OtherEntry, class OtherBlockLength, class OtherNumInGroup, class OtherLength>
class	SbeGroupEntries

Detailed Description

template<class EntryType, class BlockLength, class NumInGroup, class Length>
class OnixS::ICE::BOE::Messaging::SbeGroupEntries< EntryType, BlockLength, NumInGroup, Length >

Definition at line 441 of file SbeMessage.h.

Member Typedef Documentation

EncodedLength

template<class EntryType, class BlockLength, class NumInGroup, class Length>

typedef Length EncodedLength

The length of the binary data occupied by the group entries.

Definition at line 445 of file SbeMessage.h.

Entry

template<class EntryType, class BlockLength, class NumInGroup, class Length>

typedef EntryType Entry

The type of the repeating group entry.

Definition at line 448 of file SbeMessage.h.

Size

template<class EntryType, class BlockLength, class NumInGroup, class Length>

typedef NumInGroup Size

Number of entries in the collection.

Definition at line 451 of file SbeMessage.h.

Constructor & Destructor Documentation

SbeGroupEntries() [1/3]

template<class EntryType, class BlockLength, class NumInGroup, class Length>

SbeGroupEntries ( )

inlinenoexcept

Initializes a blank instance referencing to nothing.

Definition at line 575 of file SbeMessage.h.

        : encoded_(nullptr)
        , blockLength_(0)
        , size_(0)
        , version_(0)
    {
    }

SbeGroupEntries() [2/3]

template<class EntryType, class BlockLength, class NumInGroup, class Length>

SbeGroupEntries ( void * encoded, BlockLength blockLength, Size groupSize, SchemaVersion version )

inlinenoexcept

Initializes the instance referencing to data.

Definition at line 584 of file SbeMessage.h.

        : encoded_(encoded)
        , blockLength_(blockLength)
        , size_(groupSize)
        , version_(version)
    {
        assert(encoded_);
        assert(blockLength > 0);
        assert(version != 0);
    }

SbeGroupEntries() [3/3]

template<class EntryType, class BlockLength, class NumInGroup, class Length>

template<class OtherEntry, class OtherBlockLength, class OtherNumInGroup, class OtherLength>

SbeGroupEntries ( const SbeGroupEntries< OtherEntry, OtherBlockLength, OtherNumInGroup, OtherLength > & other )

inlinenoexcept

Copy constructor.

Definition at line 650 of file SbeMessage.h.

        : encoded_(other.encoded_)
        , blockLength_(other.blockLength_)
        , size_(other.size_)
        , version_(other.version_)
    {
        // Dimension types may vary for the different instantiations of the template.
        // Therefore, truncation of the dimensions must be avoided.
 
        assert(blockLength_ == other.blockLength_);
        assert(size_ == other.size_);
    }

Member Function Documentation

begin()

template<class EntryType, class BlockLength, class NumInGroup, class Length>

Iterator begin ( ) const

inline

Returns

the iterator pointing to the first repeating group entry.

Definition at line 614 of file SbeMessage.h.

    {
        return Iterator(encoded(), blockLength_, version_);
    }

empty()

template<class EntryType, class BlockLength, class NumInGroup, class Length>

bool empty ( ) const

inlinenoexcept

Returns

true if the referenced repeating group is empty, otherwise - false.

Definition at line 602 of file SbeMessage.h.

    {
        return (0 == size_);
    }

encoded()

template<class EntryType, class BlockLength, class NumInGroup, class Length>

void * encoded ( ) const

inlinenoexcept

Returns

Binary data occupied by the group entries.

Definition at line 637 of file SbeMessage.h.

    {
        return encoded_;
    }

encodedLength()

template<class EntryType, class BlockLength, class NumInGroup, class Length>

EncodedLength encodedLength ( ) const

inlinenoexcept

Returns

the length of the binary data occupied by the group entries.

Definition at line 643 of file SbeMessage.h.

    {
        return (static_cast<EncodedLength>(blockLength_) * static_cast<EncodedLength>(size_) );
    }

end()

template<class EntryType, class BlockLength, class NumInGroup, class Length>

Iterator end ( ) const

inline

Returns the iterator pointing to the entry behind the end of the group.

Definition at line 620 of file SbeMessage.h.

    {
        return Iterator(advanceByBytes(encoded(), encodedLength()), blockLength_, version_);
    }

operator=()

template<class EntryType, class BlockLength, class NumInGroup, class Length>

template<class OtherEntry, class OtherBlockLength, class OtherNumInGroup, class OtherLength>

SbeGroupEntries & operator= ( const SbeGroupEntries< OtherEntry, OtherBlockLength, OtherNumInGroup, OtherLength > & other )

inlinenoexcept

Definition at line 664 of file SbeMessage.h.

    {
        encoded_ = other.encoded_;
 
        blockLength_ = other.blockLength_;
 
        assert(blockLength_ == other.blockLength_);
 
        size_ = other.size_;
 
        assert(size_ == other.size_);
 
        version_ = other.version_;
 
        return *this;
    }

operator[]()

template<class EntryType, class BlockLength, class NumInGroup, class Length>

Entry operator[] ( Size index ) const

inline

Provides access to the group entry by its index in the repeating group.

Note

Index validness is not checked due to performance considerations.

Definition at line 628 of file SbeMessage.h.

    {
        assert(index < size_);
        assert(encoded_);
 
        return Entry(advanceByBytes(encoded_, static_cast<ptrdiff_t>(index) * blockLength_), blockLength_, version_);
    }

size()

template<class EntryType, class BlockLength, class NumInGroup, class Length>

Size size ( ) const

inlinenoexcept

Returns

number of blocks.

Definition at line 608 of file SbeMessage.h.

    {
        return size_;
    }

valid()

template<class EntryType, class BlockLength, class NumInGroup, class Length>

bool valid ( ) const

inlinenoexcept

Returns

true if the instance refers to a valid repeating group, otherwise - false.

Definition at line 596 of file SbeMessage.h.

    {
        return (nullptr != encoded_);
    }

Friends And Related Symbol Documentation

SbeGroupEntries

template<class EntryType, class BlockLength, class NumInGroup, class Length>

template<class OtherEntry, class OtherBlockLength, class OtherNumInGroup, class OtherLength>

friend class SbeGroupEntries

friend

Definition at line 683 of file SbeMessage.h.