iox2::EntryHandleMut< S, KeyType, ValueType > Class Template Reference

A handle for direct write access to a specific blackboard value. More...

#include <entry_handle_mut.hpp>

Public Member Functions
	EntryHandleMut (EntryHandleMut &&rhs) noexcept
auto	operator= (EntryHandleMut &&rhs) noexcept -> EntryHandleMut &
	~EntryHandleMut () noexcept
	EntryHandleMut (const EntryHandleMut &)=delete
auto	operator= (const EntryHandleMut &) -> EntryHandleMut &=delete
void	update_with_copy (ValueType value)
	Updates the value by copying the passed value into it.
auto	entry_id () const -> EventId

Friends
template<ServiceType , typename >
class	Writer
template<ServiceType ST, typename KeyT , typename ValueT >
auto	loan_uninit (EntryHandleMut< ST, KeyT, ValueT > &&self) -> EntryValueUninit< ST, KeyT, ValueT >
	Consumes the [EntryHandleMut] and loans an uninitialized entry value that can be used to update without copy.
template<ServiceType ST, typename KeyT , typename ValueT >
auto	update_with_copy (EntryValueUninit< ST, KeyT, ValueT > &&, ValueT) -> EntryHandleMut< ST, KeyT, ValueT >
template<ServiceType ST, typename KeyT , typename ValueT >
auto	discard (EntryValueUninit< ST, KeyT, ValueT > &&self) -> EntryHandleMut< ST, KeyT, ValueT >
template<ServiceType ST, typename KeyT , typename ValueT >
auto	assume_init_and_update (EntryValueUninit< ST, KeyT, ValueT > &&self) -> EntryHandleMut< ST, KeyT, ValueT >

Detailed Description

template<ServiceType S, typename KeyType, typename ValueType>
class iox2::EntryHandleMut< S, KeyType, ValueType >

A handle for direct write access to a specific blackboard value.

Definition at line 23 of file entry_handle_mut.hpp.

Constructor & Destructor Documentation

EntryHandleMut() [1/2]

template<ServiceType S, typename KeyType , typename ValueType >

iox2::EntryHandleMut< S, KeyType, ValueType >::EntryHandleMut ( EntryHandleMut< S, KeyType, ValueType > &&  rhs )

inlinenoexcept

Definition at line 68 of file entry_handle_mut.hpp.

~EntryHandleMut()

template<ServiceType S, typename KeyType , typename ValueType >

iox2::EntryHandleMut< S, KeyType, ValueType >::~EntryHandleMut ( )

inlinenoexcept

Definition at line 84 of file entry_handle_mut.hpp.

EntryHandleMut() [2/2]

template<ServiceType S, typename KeyType , typename ValueType >

iox2::EntryHandleMut< S, KeyType, ValueType >::EntryHandleMut ( const EntryHandleMut< S, KeyType, ValueType > &  )

delete

Member Function Documentation

entry_id()

template<ServiceType S, typename KeyType , typename ValueType >

auto iox2::EntryHandleMut< S, KeyType, ValueType >::entry_id ( ) const -> EventId

inline

Returns an ID corresponding to the entry which can be used in an event based communication setup.

Definition at line 103 of file entry_handle_mut.hpp.

References iox2::EntryHandleMut< S, KeyType, ValueType >::entry_id().

Referenced by iox2::EntryHandleMut< S, KeyType, ValueType >::entry_id().

operator=() [1/2]

template<ServiceType S, typename KeyType , typename ValueType >

auto iox2::EntryHandleMut< S, KeyType, ValueType >::operator= ( const EntryHandleMut< S, KeyType, ValueType > &  ) -> EntryHandleMut &=delete

delete

operator=() [2/2]

template<ServiceType S, typename KeyType , typename ValueType >

auto iox2::EntryHandleMut< S, KeyType, ValueType >::operator= ( EntryHandleMut< S, KeyType, ValueType > &&  rhs ) -> EntryHandleMut&

inlinenoexcept

Definition at line 73 of file entry_handle_mut.hpp.

update_with_copy()

template<ServiceType S, typename KeyType , typename ValueType >

void iox2::EntryHandleMut< S, KeyType, ValueType >::update_with_copy ( ValueType  value )

inline

Updates the value by copying the passed value into it.

Definition at line 89 of file entry_handle_mut.hpp.

Friends And Related Symbol Documentation

assume_init_and_update

template<ServiceType S, typename KeyType , typename ValueType >

template<ServiceType ST, typename KeyT , typename ValueT >

auto assume_init_and_update ( EntryValueUninit< ST, KeyT, ValueT > &&  self ) -> EntryHandleMut< ST, KeyT, ValueT >

friend

discard

template<ServiceType S, typename KeyType , typename ValueType >

template<ServiceType ST, typename KeyT , typename ValueT >

auto discard ( EntryValueUninit< ST, KeyT, ValueT > &&  self ) -> EntryHandleMut< ST, KeyT, ValueT >

friend

loan_uninit

template<ServiceType S, typename KeyType , typename ValueType >

template<ServiceType ST, typename KeyT , typename ValueT >

auto loan_uninit ( EntryHandleMut< ST, KeyT, ValueT > &&  self ) -> EntryValueUninit< ST, KeyT, ValueT >

friend

Consumes the [EntryHandleMut] and loans an uninitialized entry value that can be used to update without copy.

update_with_copy

template<ServiceType S, typename KeyType , typename ValueType >

template<ServiceType ST, typename KeyT , typename ValueT >

auto update_with_copy ( EntryValueUninit< ST, KeyT, ValueT > &&  , ValueT    ) -> EntryHandleMut< ST, KeyT, ValueT >

friend

Writer

template<ServiceType S, typename KeyType , typename ValueType >

template<ServiceType , typename >

friend class Writer

friend

Definition at line 45 of file entry_handle_mut.hpp.

---

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

• iox2/entry_handle_mut.hpp