OnixS C++ CME MDP Conflated UDP Handler  1.1.2
API documentation
BinaryGroupEntries< EntryType, BlockLength, NumInGroup, Length > Class Template Reference

#include <OnixS/CME/ConflatedUDP/BinaryMessage.h>

Classes

class  Iterator
 

Public Types

typedef Length EncodedLength
 
typedef EntryType Entry
 
typedef NumInGroup Size
 

Public Member Functions

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

Friends

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

Detailed Description

template<class EntryType, class BlockLength, class NumInGroup, class Length>
class OnixS::CME::ConflatedUDP::BinaryGroupEntries< EntryType, BlockLength, NumInGroup, Length >

Definition at line 570 of file BinaryMessage.h.

Member Typedef Documentation

typedef Length EncodedLength

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

Definition at line 595 of file BinaryMessage.h.

typedef EntryType Entry

The type of repeating group entry.

Definition at line 598 of file BinaryMessage.h.

typedef NumInGroup Size

Number of entries in the collection.

Definition at line 601 of file BinaryMessage.h.

Constructor & Destructor Documentation

BinaryGroupEntries ( )
inline

Initializes blank instance referencing to nothing.

Definition at line 788 of file BinaryMessage.h.

BinaryGroupEntries ( const void *  encoded,
BlockLength  blockLength,
Size  groupSize,
SchemaVersion  version 
)
inline

Initializes the instance referencing to a real data.

Definition at line 797 of file BinaryMessage.h.

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

Initializes instance as a copy of the other one.

Definition at line 817 of file BinaryMessage.h.

Member Function Documentation

Iterator begin ( ) const
inline

Returns iterator pointing to the first repeating group entry.

Definition at line 869 of file BinaryMessage.h.

bool empty ( ) const
inline

Indicates whether a repeating group being referenced is empty.

Definition at line 857 of file BinaryMessage.h.

const void* encoded ( ) const
inline

Binary data occupied by the given group entries.

Definition at line 927 of file BinaryMessage.h.

EncodedLength encodedLength ( ) const
inline

Length of the binary data occupied by the given collection of entries.

Definition at line 934 of file BinaryMessage.h.

Iterator end ( ) const
inline

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

Definition at line 879 of file BinaryMessage.h.

operator bool ( ) const
inline

Indicates whether given instance refers to a valid repeating group.

Definition at line 850 of file BinaryMessage.h.

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

Re-initializes instance as copy of the other one. Initializes instance as a copy of the other one.

Definition at line 957 of file BinaryMessage.h.

const Entry operator[] ( Size  index) const
inline

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

Index validness is not checked due to performance considerations.

Definition at line 904 of file BinaryMessage.h.

Size size ( ) const
inline

Returns number of blocks.

Definition at line 863 of file BinaryMessage.h.

Friends And Related Function Documentation

friend class BinaryGroupEntries
friend

Definition at line 581 of file BinaryMessage.h.


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