iox2::AttributeVerifier Class Reference

#include <attribute_verifier.hpp>

Public Member Functions
	AttributeVerifier ()
	Creates a new empty set of [Attribute]s.
	AttributeVerifier (const AttributeVerifier &)=delete
	AttributeVerifier (AttributeVerifier &&) noexcept
	~AttributeVerifier ()
auto	operator= (const AttributeVerifier &) -> AttributeVerifier &=delete
auto	operator= (AttributeVerifier &&) noexcept -> AttributeVerifier &
auto	require (const Attribute::Key &key, const Attribute::Value &value) -> bb::Expected< void, AttributeDefinitionError >
	Requires a value for a specific key. A key is allowed to have multiple values.
auto	require_key (const Attribute::Key &key) -> bb::Expected< void, AttributeDefinitionError >
	Requires that a specific key is defined.
auto	attributes () const -> AttributeSetView
	Returns the underlying required [AttributeSet].
auto	keys () const -> iox2::bb::StaticVector< Attribute::Key, IOX2_MAX_ATTRIBUTES_PER_SERVICE >
	Returns the underlying required keys.
auto	verify_requirements (const AttributeSetView &rhs) const -> bb::Expected< void, Attribute::Key >
	Verifies if the [AttributeSet] contains all required keys and key-value pairs.

Friends
template<ServiceType >
class	ServiceBuilderEvent
template<typename , typename , ServiceType >
class	ServiceBuilderPublishSubscribe
template<typename , typename , typename , typename , ServiceType >
class	ServiceBuilderRequestResponse
template<typename , ServiceType >
class	ServiceBuilderBlackboardOpener

Detailed Description

Represents the set of [Attribute]s that are required when the [Service] is opened.

Definition at line 26 of file attribute_verifier.hpp.

Constructor & Destructor Documentation

AttributeVerifier() [1/3]

iox2::AttributeVerifier::AttributeVerifier

(

)

Creates a new empty set of [Attribute]s.

AttributeVerifier() [2/3]

iox2::AttributeVerifier::AttributeVerifier ( const AttributeVerifier &  )

delete

AttributeVerifier() [3/3]

iox2::AttributeVerifier::AttributeVerifier ( AttributeVerifier &&  )

noexcept

~AttributeVerifier()

iox2::AttributeVerifier::~AttributeVerifier

(

)

Member Function Documentation

attributes()

auto iox2::AttributeVerifier::attributes

(

)

const -> AttributeSetView

Returns the underlying required [AttributeSet].

keys()

auto iox2::AttributeVerifier::keys

(

)

const -> iox2::bb::StaticVector< Attribute::Key, IOX2_MAX_ATTRIBUTES_PER_SERVICE >

Returns the underlying required keys.

operator=() [1/2]

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

noexcept

operator=() [2/2]

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

delete

require()

auto iox2::AttributeVerifier::require	(	const Attribute::Key &	key,
		const Attribute::Value &	value
	)		-> bb::Expected< void, AttributeDefinitionError >

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

require_key()

auto iox2::AttributeVerifier::require_key

(

const Attribute::Key &

key

)

-> bb::Expected< void, AttributeDefinitionError >

Requires that a specific key is defined.

verify_requirements()

auto iox2::AttributeVerifier::verify_requirements

(

const AttributeSetView &

rhs

)

const -> bb::Expected< void, Attribute::Key >

Verifies if the [AttributeSet] contains all required keys and key-value pairs.

Friends And Related Symbol Documentation

ServiceBuilderBlackboardOpener

template<typename , ServiceType >

friend class ServiceBuilderBlackboardOpener

friend

Definition at line 61 of file attribute_verifier.hpp.

ServiceBuilderEvent

template<ServiceType >

friend class ServiceBuilderEvent

friend

Definition at line 55 of file attribute_verifier.hpp.

ServiceBuilderPublishSubscribe

template<typename , typename , ServiceType >

friend class ServiceBuilderPublishSubscribe

friend

Definition at line 57 of file attribute_verifier.hpp.

ServiceBuilderRequestResponse

template<typename , typename , typename , typename , ServiceType >

friend class ServiceBuilderRequestResponse

friend

Definition at line 59 of file attribute_verifier.hpp.

---

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

• iox2/attribute_verifier.hpp