iceoryx_doc
1.0.1
|
typed version so we can use operator-> More...
#include <relocatable_pointer.hpp>
Public Member Functions | |
RelocatablePointer () noexcept | |
default constructs a logical nullptr | |
RelocatablePointer (const T *ptr) noexcept | |
creates a RelocatablePointer pointing to the same pointee as ptr More... | |
RelocatablePointer (const BaseRelocatablePointer &other) noexcept | |
creates a RelocatablePointer from a BaseRelocatablePointer More... | |
RelocatablePointer (T *rawPtr) noexcept | |
creates a RelocatablePointer pointing to the same pointee as rawPtr More... | |
RelocatablePointer & | operator= (const BaseRelocatablePointer &other) noexcept |
assign this to point to the same pointee as the BaseRelocatablePointer other More... | |
T & | operator* () noexcept |
dereferencing operator which returns a reference to the pointee More... | |
T * | operator-> () noexcept |
access to the underlying object in shared memory More... | |
const T & | operator* () const noexcept |
dereferencing operator which returns a const reference to the pointee More... | |
const T * | operator-> () const noexcept |
read-only access to the underlying object in shared memory More... | |
T & | operator[] (uint64_t index) noexcept |
returns a reference to the memory location of the underlying object + an offset More... | |
operator T* () const noexcept | |
converts the RelocatablePointer to a pointer of the type of the underlying object More... | |
![]() | |
BaseRelocatablePointer () noexcept | |
default constructs a logical nullptr | |
BaseRelocatablePointer (const void *ptr) noexcept | |
creates a relocatable pointer pointing to the same pointee as ptr More... | |
BaseRelocatablePointer (const BaseRelocatablePointer &other) noexcept | |
copy constructor More... | |
BaseRelocatablePointer (BaseRelocatablePointer &&other) noexcept | |
move constructor More... | |
BaseRelocatablePointer & | operator= (const BaseRelocatablePointer &other) noexcept |
copy assignment More... | |
BaseRelocatablePointer & | operator= (const void *rawPtr) noexcept |
assign BaseRelocatablePointer to point to the same pointee as rawPtr More... | |
BaseRelocatablePointer & | operator= (BaseRelocatablePointer &&other) noexcept |
move assignment More... | |
const void * | operator* () const noexcept |
read-only access to the underlying object in shared memory More... | |
operator bool () const noexcept | |
checks if this is not a logical nullptr More... | |
bool | operator! () const noexcept |
checks if this is a logical nullptr More... | |
const void * | get () const noexcept |
access to the underlying object in shared memory More... | |
offset_t | getOffset () const noexcept |
returns the offset More... | |
Additional Inherited Members | |
![]() | |
using | offset_t = std::ptrdiff_t |
![]() | |
static constexpr offset_t | NULL_POINTER_OFFSET = std::numeric_limits<offset_t>::max() |
![]() | |
offset_t | computeOffset (const void *ptr) const noexcept |
void * | computeRawPtr () const noexcept |
![]() | |
offset_t | m_offset {NULL_POINTER_OFFSET} |
typed version so we can use operator->
|
inlinenoexcept |
creates a RelocatablePointer pointing to the same pointee as ptr
[in] | ptr | the pointer whose pointee shall be the same for this |
|
inlinenoexcept |
creates a RelocatablePointer from a BaseRelocatablePointer
[in] | other | is the BaseRelocatablePointer |
|
inlinenoexcept |
creates a RelocatablePointer pointing to the same pointee as rawPtr
[in] | rawPtr | the pointer whose pointee shall be the same for this |
|
inlinenoexcept |
converts the RelocatablePointer to a pointer of the type of the underlying object
|
inlinenoexcept |
dereferencing operator which returns a const reference to the pointee
|
inlinenoexcept |
dereferencing operator which returns a reference to the pointee
|
inlinenoexcept |
read-only access to the underlying object in shared memory
|
inlinenoexcept |
access to the underlying object in shared memory
|
inlinenoexcept |
assign this to point to the same pointee as the BaseRelocatablePointer other
[in] | other | the pointer whose pointee shall be the same for this |
|
inlinenoexcept |
returns a reference to the memory location of the underlying object + an offset
[in] | index | is the offset |