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

#include <attribute_specifier.hpp>

Public Member Functions

 AttributeSpecifier ()
 Creates a new empty set of [Attribute]s.
 
 AttributeSpecifier (const AttributeSpecifier &)=delete
 
 AttributeSpecifier (AttributeSpecifier &&) noexcept
 
 ~AttributeSpecifier ()
 
auto operator= (const AttributeSpecifier &) -> AttributeSpecifier &=delete
 
auto operator= (AttributeSpecifier &&) noexcept -> AttributeSpecifier &
 
auto define (const Attribute::Key &key, const Attribute::Value &value) -> bb::Expected< void, AttributeDefinitionError >
 Defines a value for a specific key. A key is allowed to have multiple values.
 
auto attributes () const -> AttributeSetView
 Returns the underlying [AttributeSetView].
 

Friends

template<ServiceType >
class ServiceBuilderEvent
 
template<typename , typename , ServiceType >
class ServiceBuilderPublishSubscribe
 
template<typename , typename , typename , typename , ServiceType >
class ServiceBuilderRequestResponse
 
template<typename , ServiceType >
class ServiceBuilderBlackboardCreator
 

Detailed Description

Represents the set of [Attribute]s that are defined when the [Service] is created.

Definition at line 25 of file attribute_specifier.hpp.

Constructor & Destructor Documentation

◆ AttributeSpecifier() [1/3]

iox2::AttributeSpecifier::AttributeSpecifier ( )

Creates a new empty set of [Attribute]s.

◆ AttributeSpecifier() [2/3]

iox2::AttributeSpecifier::AttributeSpecifier ( const AttributeSpecifier )
delete

◆ AttributeSpecifier() [3/3]

iox2::AttributeSpecifier::AttributeSpecifier ( AttributeSpecifier &&  )
noexcept

◆ ~AttributeSpecifier()

iox2::AttributeSpecifier::~AttributeSpecifier ( )

Member Function Documentation

◆ attributes()

auto iox2::AttributeSpecifier::attributes ( ) const -> AttributeSetView

Returns the underlying [AttributeSetView].

◆ define()

auto iox2::AttributeSpecifier::define ( const Attribute::Key key,
const Attribute::Value value 
) -> bb::Expected< void, AttributeDefinitionError >

Defines a value for a specific key. A key is allowed to have multiple values.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

auto iox2::AttributeSpecifier::operator= ( const AttributeSpecifier ) -> AttributeSpecifier &=delete
delete

Friends And Related Symbol Documentation

◆ ServiceBuilderBlackboardCreator

template<typename , ServiceType >
friend class ServiceBuilderBlackboardCreator
friend

Definition at line 51 of file attribute_specifier.hpp.

◆ ServiceBuilderEvent

template<ServiceType >
friend class ServiceBuilderEvent
friend

Definition at line 45 of file attribute_specifier.hpp.

◆ ServiceBuilderPublishSubscribe

template<typename , typename , ServiceType >
friend class ServiceBuilderPublishSubscribe
friend

Definition at line 47 of file attribute_specifier.hpp.

◆ ServiceBuilderRequestResponse

template<typename , typename , typename , typename , ServiceType >
friend class ServiceBuilderRequestResponse
friend

Definition at line 49 of file attribute_specifier.hpp.


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