iox2::PortName Class Reference

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

#include <port_name.hpp>

Public Member Functions
	PortName (PortName &&) noexcept
auto	operator= (PortName &&) noexcept -> PortName &
	PortName (const PortName &)
auto	operator= (const PortName &) -> PortName &
	~PortName () noexcept
auto	as_view () const -> PortNameView
	Creates a [PortNameView].
auto	to_string () const -> iox2::bb::StaticString< IOX2_PORT_NAME_LENGTH >
	Returns a [iox2::bb::StaticString] containing the [PortName].

Static Public Member Functions
static auto	create (const char *value) -> iox2::bb::Expected< PortName, bb::SemanticStringError >

Friends
class	PortNameView

Detailed Description

Represent the name for a [Port].

Definition at line 52 of file port_name.hpp.

Constructor & Destructor Documentation

PortName() [1/2]

iox2::PortName::PortName ( PortName &&  )

noexcept

PortName() [2/2]

iox2::PortName::PortName

(

const PortName &

)

~PortName()

iox2::PortName::~PortName ( )

noexcept

Member Function Documentation

as_view()

auto iox2::PortName::as_view

(

)

const -> PortNameView

Creates a [PortNameView].

create()

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

static

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

operator=() [1/2]

auto iox2::PortName::operator=

(

const PortName &

)

-> PortName &

operator=() [2/2]

auto iox2::PortName::operator= ( PortName &&  ) -> PortName &

noexcept

to_string()

auto iox2::PortName::to_string

(

)

const -> iox2::bb::StaticString< IOX2_PORT_NAME_LENGTH >

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

Friends And Related Symbol Documentation

PortNameView

friend class PortNameView

friend

Definition at line 72 of file port_name.hpp.

---

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

• iox2/port_name.hpp