iceoryx2
C++ Language Bindings
Loading...
Searching...
No Matches
iox2::NodeNameView Class Reference

Non-owning view of a [NodeName]. More...

#include <node_name.hpp>

Public Member Functions

 NodeNameView (NodeNameView &&)=default
 
 NodeNameView (const NodeNameView &)=default
 
auto operator= (NodeNameView &&) -> NodeNameView &=default
 
auto operator= (const NodeNameView &) -> NodeNameView &=default
 
 ~NodeNameView ()=default
 
auto to_string () const -> iox2::bb::StaticString< IOX2_NODE_NAME_LENGTH >
 Returns a [iox2::bb::StaticString] containing the [NodeName].
 
auto to_owned () const -> NodeName
 Creates a copy of the corresponding [NodeName] and returns it.
 

Friends

template<ServiceType >
class Node
 
class NodeName
 
template<ServiceType >
auto internal::list_callback (iox2_node_state_e, iox2_unique_node_id_ptr, const char *executable, iox2_node_name_ptr, iox2_config_ptr, iox2_callback_context) -> iox2_callback_progression_e
 

Detailed Description

Non-owning view of a [NodeName].

Definition at line 33 of file node_name.hpp.

Constructor & Destructor Documentation

◆ NodeNameView() [1/2]

iox2::NodeNameView::NodeNameView ( NodeNameView &&  )
default

◆ NodeNameView() [2/2]

iox2::NodeNameView::NodeNameView ( const NodeNameView )
default

◆ ~NodeNameView()

iox2::NodeNameView::~NodeNameView ( )
default

Member Function Documentation

◆ operator=() [1/2]

auto iox2::NodeNameView::operator= ( const NodeNameView ) -> NodeNameView &=default
default

◆ operator=() [2/2]

auto iox2::NodeNameView::operator= ( NodeNameView &&  ) -> NodeNameView &=default
default

◆ to_owned()

auto iox2::NodeNameView::to_owned ( ) const -> NodeName

Creates a copy of the corresponding [NodeName] and returns it.

Referenced by iox2::internal::list_callback().

◆ to_string()

auto iox2::NodeNameView::to_string ( ) const -> iox2::bb::StaticString< IOX2_NODE_NAME_LENGTH >

Returns a [iox2::bb::StaticString] containing the [NodeName].

Friends And Related Symbol Documentation

◆ internal::list_callback

template<ServiceType >
auto internal::list_callback ( iox2_node_state_e  ,
iox2_unique_node_id_ptr  ,
const char *  executable,
iox2_node_name_ptr  ,
iox2_config_ptr  ,
iox2_callback_context   
) -> iox2_callback_progression_e
friend

◆ Node

template<ServiceType >
friend class Node
friend

Definition at line 49 of file node_name.hpp.

◆ NodeName

friend class NodeName
friend

Definition at line 50 of file node_name.hpp.


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