RTI Connext Modern C++ API  Version 6.1.0
rti::flat::MutableArrayOffset< ElementOffset, N > Class Template Reference

Offset to an array of variable-size elements. More...

#include <SequenceOffsets.hpp>

Inheritance diagram for rti::flat::MutableArrayOffset< ElementOffset, N >:
rti::flat::AbstractAlignedList< ElementOffset > rti::flat::OffsetBase

Public Member Functions

ElementOffset get_element (unsigned int i)
 Gets the Offset to an element. More...
 
- Public Member Functions inherited from rti::flat::AbstractAlignedList< ElementOffset >
iterator begin ()
 Gets an iterator to the first Offset. More...
 
iterator end ()
 Gets an iterator to the past-the-end element. More...
 
- Public Member Functions inherited from rti::flat::OffsetBase
bool is_null () const
 Indicates whether this Offset doesn't point to a valid element. More...
 
bool is_cpp_compatible () const
 Indicates whether rti::flat::plain_cast() is possible. More...
 
const unsigned char * get_buffer () const
 Gets this member's position in the buffer. More...
 
offset_t get_buffer_size () const
 Gets the size, in bytes, of this member in the buffer. More...
 

Additional Inherited Members

- Public Types inherited from rti::flat::AbstractAlignedList< ElementOffset >
typedef SequenceIterator< ElementOffset, typename ElementOffset::offset_kind > iterator
 The iterator type, SequenceIterator. More...
 

Detailed Description

template<typename ElementOffset, unsigned int N>
class rti::flat::MutableArrayOffset< ElementOffset, N >

Offset to an array of variable-size elements.

Template Parameters
ElementOffsetAn Offset for a type of variable size, such as a mutable struct (MyFlatMutableOffset), union, or StringOffset.
NThe array bound. For multidimensional arrays, N is the product of each dimension bound.

Represents an Offset to an array member and allows getting an Offset to each of its elements.

See also
FinalArrayOffset encapsulates arrays of fixed-size elements

Member Function Documentation

◆ get_element()

template<typename ElementOffset, unsigned int N>
ElementOffset rti::flat::MutableArrayOffset< ElementOffset, N >::get_element ( unsigned int  i)
inline

Gets the Offset to an element.

Parameters
iThe zero-based index to the element
Returns
The Offset to the element in the i-th position