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

Represent the name for a [Node]. More...

#include <node_name.hpp>

Public Member Functions

 NodeName (NodeName &&) noexcept
 
auto operator= (NodeName &&) noexcept -> NodeName &
 
 NodeName (const NodeName &)
 
auto operator= (const NodeName &) -> NodeName &
 
 ~NodeName ()
 
auto as_view () const -> NodeNameView
 Creates a [NodeNameView].
 
auto to_string () const -> iox2::bb::StaticString< IOX2_NODE_NAME_LENGTH >
 Returns a [iox2::bb::StaticString] containing the [NodeName].
 

Static Public Member Functions

static auto create (const char *value) -> iox2::bb::Expected< NodeName, bb::SemanticStringError >
 

Friends

class NodeBuilder
 
class NodeNameView
 

Detailed Description

Represent the name for a [Node].

Definition at line 64 of file node_name.hpp.

Constructor & Destructor Documentation

◆ NodeName() [1/2]

iox2::NodeName::NodeName ( NodeName &&  )
noexcept

◆ NodeName() [2/2]

iox2::NodeName::NodeName ( const NodeName )

◆ ~NodeName()

iox2::NodeName::~NodeName ( )

Member Function Documentation

◆ as_view()

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

Creates a [NodeNameView].

◆ create()

static auto iox2::NodeName::create ( const char *  value) -> iox2::bb::Expected< NodeName, bb::SemanticStringError >
static

Creates a new [NodeName]. If the provided name does not contain a valid [NodeName] it will return a [SemanticStringError] otherwise the [NodeName].

◆ operator=() [1/2]

auto iox2::NodeName::operator= ( const NodeName ) -> NodeName &

◆ operator=() [2/2]

auto iox2::NodeName::operator= ( NodeName &&  ) -> NodeName &
noexcept

◆ to_string()

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

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

Friends And Related Symbol Documentation

◆ NodeBuilder

friend class NodeBuilder
friend

Definition at line 84 of file node_name.hpp.

◆ NodeNameView

friend class NodeNameView
friend

Definition at line 85 of file node_name.hpp.


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