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

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

#include <entry_handle.hpp>

Public Member Functions
	EntryHandle (EntryHandle &&rhs) noexcept
auto	operator= (EntryHandle &&rhs) noexcept -> EntryHandle &
	~EntryHandle ()
	EntryHandle (const EntryHandle &)=delete
auto	operator= (const EntryHandle &) -> EntryHandle &=delete
auto	get () const -> BlackboardValue< ValueType >
	Returns a copy of the value wrapped in a [BlackboardValue].
auto	is_up_to_date (BlackboardValue< ValueType > &value) const -> bool
	Checks if the passed value is up-to-date.
auto	entry_id () const -> EventId

Friends
template<ServiceType , typename >
class	Reader

Detailed Description

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

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

Definition at line 50 of file entry_handle.hpp.

Constructor & Destructor Documentation

EntryHandle() [1/2]

template<ServiceType S, typename KeyType , typename ValueType >

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

inlinenoexcept

Definition at line 93 of file entry_handle.hpp.

~EntryHandle()

template<ServiceType S, typename KeyType , typename ValueType >

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

inline

Definition at line 109 of file entry_handle.hpp.

EntryHandle() [2/2]

template<ServiceType S, typename KeyType , typename ValueType >

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

delete

Member Function Documentation

entry_id()

template<ServiceType S, typename KeyType , typename ValueType >

auto iox2::EntryHandle< 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 114 of file entry_handle.hpp.

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

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

get()

template<ServiceType S, typename KeyType , typename ValueType >

auto iox2::EntryHandle< S, KeyType, ValueType >::get ( ) const -> BlackboardValue<ValueType>

inline

Returns a copy of the value wrapped in a [BlackboardValue].

Definition at line 123 of file entry_handle.hpp.

is_up_to_date()

template<ServiceType S, typename KeyType , typename ValueType >

auto iox2::EntryHandle< S, KeyType, ValueType >::is_up_to_date ( BlackboardValue< ValueType > &  value ) const -> bool

inline

Checks if the passed value is up-to-date.

Definition at line 133 of file entry_handle.hpp.

operator=() [1/2]

template<ServiceType S, typename KeyType , typename ValueType >

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

delete

operator=() [2/2]

template<ServiceType S, typename KeyType , typename ValueType >

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

inlinenoexcept

Definition at line 98 of file entry_handle.hpp.

Friends And Related Symbol Documentation

Reader

template<ServiceType S, typename KeyType , typename ValueType >

template<ServiceType , typename >

friend class Reader

friend

Definition at line 71 of file entry_handle.hpp.

---

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

• iox2/entry_handle.hpp