iceoryx2
C++ Language Bindings
Loading...
Searching...
No Matches
iox2::SampleMutUninit< S, Payload, UserHeader > Class Template Reference

#include <sample_mut_uninit.hpp>

Public Member Functions

 SampleMutUninit (SampleMutUninit &&rhs) noexcept=default
 
auto operator= (SampleMutUninit &&rhs) noexcept -> SampleMutUninit &=default
 
 ~SampleMutUninit () noexcept=default
 
 SampleMutUninit (const SampleMutUninit &)=delete
 
auto operator= (const SampleMutUninit &) -> SampleMutUninit &=delete
 
auto header () const -> HeaderPublishSubscribe
 Returns a reference to the [Header] of the [Sample].
 
template<typename T = UserHeader, typename = std::enable_if_t<!std::is_same<void, UserHeader>::value, T>>
auto user_header () const -> const T &
 Returns a reference to the user_header of the [Sample].
 
template<typename T = UserHeader, typename = std::enable_if_t<!std::is_same<void, UserHeader>::value, T>>
auto user_header_mut () -> T &
 Returns a mutable reference to the user_header of the [Sample].
 
template<typename T = Payload, typename = std::enable_if_t<!bb::IsSlice<T>::VALUE, void>>
auto payload () const -> const ValueType &
 Returns a reference to the const payload of the sample.
 
template<typename T = Payload, typename = std::enable_if_t<!bb::IsSlice<T>::VALUE, void>>
auto payload_mut () -> ValueType &
 Returns a reference to the payload of the sample.
 
template<typename T = Payload, typename = std::enable_if_t<bb::IsSlice<T>::VALUE, void>>
auto payload () const -> bb::ImmutableSlice< ValueType >
 
template<typename T = Payload, typename = std::enable_if_t<bb::IsSlice<T>::VALUE, void>>
auto payload_mut () -> bb::MutableSlice< ValueType >
 
template<typename T = Payload, typename = std::enable_if_t<!bb::IsSlice<T>::VALUE, T>>
auto write_payload (T &&value) -> SampleMut< S, Payload, UserHeader >
 Writes the payload to the sample.
 
template<typename T = Payload, typename = std::enable_if_t<bb::IsSlice<T>::VALUE, T>>
auto write_from_fn (const iox2::bb::StaticFunction< typename T::ValueType(uint64_t)> &initializer) -> SampleMut< S, Payload, UserHeader >
 Writes the payload to the sample.
 
template<typename T = Payload, typename = std::enable_if_t<bb::IsSlice<T>::VALUE, T>>
auto write_from_slice (bb::ImmutableSlice< ValueType > &value) -> SampleMut< S, Payload, UserHeader >
 mem copies the value to the sample
 

Friends

template<ServiceType , typename , typename >
class Publisher
 
template<ServiceType ST, typename PayloadT , typename UserHeaderT >
auto assume_init (SampleMutUninit< ST, PayloadT, UserHeaderT > &&self) -> SampleMut< ST, PayloadT, UserHeaderT >
 

Detailed Description

template<ServiceType S, typename Payload, typename UserHeader>
class iox2::SampleMutUninit< S, Payload, UserHeader >

Definition at line 25 of file sample_mut_uninit.hpp.

Constructor & Destructor Documentation

◆ SampleMutUninit() [1/2]

template<ServiceType S, typename Payload , typename UserHeader >
iox2::SampleMutUninit< S, Payload, UserHeader >::SampleMutUninit ( SampleMutUninit< S, Payload, UserHeader > &&  rhs)
defaultnoexcept

◆ ~SampleMutUninit()

template<ServiceType S, typename Payload , typename UserHeader >
iox2::SampleMutUninit< S, Payload, UserHeader >::~SampleMutUninit ( )
defaultnoexcept

◆ SampleMutUninit() [2/2]

template<ServiceType S, typename Payload , typename UserHeader >
iox2::SampleMutUninit< S, Payload, UserHeader >::SampleMutUninit ( const SampleMutUninit< S, Payload, UserHeader > &  )
delete

Member Function Documentation

◆ header()

template<ServiceType S, typename Payload , typename UserHeader >
auto iox2::SampleMutUninit< S, Payload, UserHeader >::header ( ) const -> HeaderPublishSubscribe
inline

Returns a reference to the [Header] of the [Sample].

Definition at line 96 of file sample_mut_uninit.hpp.

◆ operator=() [1/2]

template<ServiceType S, typename Payload , typename UserHeader >
auto iox2::SampleMutUninit< S, Payload, UserHeader >::operator= ( const SampleMutUninit< S, Payload, UserHeader > &  ) -> SampleMutUninit &=delete
delete

◆ operator=() [2/2]

template<ServiceType S, typename Payload , typename UserHeader >
auto iox2::SampleMutUninit< S, Payload, UserHeader >::operator= ( SampleMutUninit< S, Payload, UserHeader > &&  rhs) -> SampleMutUninit &=default
defaultnoexcept

◆ payload() [1/2]

template<ServiceType S, typename Payload , typename UserHeader >
template<typename T = Payload, typename = std::enable_if_t<bb::IsSlice<T>::VALUE, void>>
auto iox2::SampleMutUninit< S, Payload, UserHeader >::payload ( ) const -> bb::ImmutableSlice< ValueType >

◆ payload() [2/2]

template<ServiceType S, typename Payload , typename UserHeader >
template<typename T , typename >
auto iox2::SampleMutUninit< S, Payload, UserHeader >::payload ( ) const -> const ValueType&
inline

Returns a reference to the const payload of the sample.

Definition at line 114 of file sample_mut_uninit.hpp.

◆ payload_mut() [1/2]

template<ServiceType S, typename Payload , typename UserHeader >
template<typename T = Payload, typename = std::enable_if_t<bb::IsSlice<T>::VALUE, void>>
auto iox2::SampleMutUninit< S, Payload, UserHeader >::payload_mut ( ) -> bb::MutableSlice< ValueType >

◆ payload_mut() [2/2]

template<ServiceType S, typename Payload , typename UserHeader >
template<typename T , typename >
auto iox2::SampleMutUninit< S, Payload, UserHeader >::payload_mut ( ) -> ValueType&
inline

◆ user_header()

template<ServiceType S, typename Payload , typename UserHeader >
template<typename T , typename >
auto iox2::SampleMutUninit< S, Payload, UserHeader >::user_header ( ) const -> const T&
inline

Returns a reference to the user_header of the [Sample].

Definition at line 102 of file sample_mut_uninit.hpp.

◆ user_header_mut()

template<ServiceType S, typename Payload , typename UserHeader >
template<typename T , typename >
auto iox2::SampleMutUninit< S, Payload, UserHeader >::user_header_mut ( ) -> T&
inline

Returns a mutable reference to the user_header of the [Sample].

Definition at line 108 of file sample_mut_uninit.hpp.

◆ write_from_fn()

template<ServiceType S, typename Payload , typename UserHeader >
template<typename T , typename >
auto iox2::SampleMutUninit< S, Payload, UserHeader >::write_from_fn ( const iox2::bb::StaticFunction< typename T::ValueType(uint64_t)> &  initializer) -> SampleMut<S, Payload, UserHeader>
inline

Writes the payload to the sample.

Definition at line 145 of file sample_mut_uninit.hpp.

References iox2::SampleMutUninit< S, Payload, UserHeader >::payload_mut().

◆ write_from_slice()

template<ServiceType S, typename Payload , typename UserHeader >
template<typename T , typename >
auto iox2::SampleMutUninit< S, Payload, UserHeader >::write_from_slice ( bb::ImmutableSlice< ValueType > &  value) -> SampleMut<S, Payload, UserHeader>
inline

mem copies the value to the sample

Definition at line 156 of file sample_mut_uninit.hpp.

References IOX2_ASSERT, and iox2::SampleMutUninit< S, Payload, UserHeader >::payload_mut().

◆ write_payload()

template<ServiceType S, typename Payload , typename UserHeader >
template<typename T , typename >
auto iox2::SampleMutUninit< S, Payload, UserHeader >::write_payload ( T &&  value) -> SampleMut<S, Payload, UserHeader>
inline

Writes the payload to the sample.

Definition at line 138 of file sample_mut_uninit.hpp.

References iox2::SampleMutUninit< S, Payload, UserHeader >::payload_mut().

Friends And Related Symbol Documentation

◆ assume_init

template<ServiceType S, typename Payload , typename UserHeader >
template<ServiceType ST, typename PayloadT , typename UserHeaderT >
auto assume_init ( SampleMutUninit< ST, PayloadT, UserHeaderT > &&  self) -> SampleMut< ST, PayloadT, UserHeaderT >
friend

◆ Publisher

template<ServiceType S, typename Payload , typename UserHeader >
template<ServiceType , typename , typename >
friend class Publisher
friend

Definition at line 76 of file sample_mut_uninit.hpp.


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