attribute_set.hpp

Go to the documentation of this file.

// Copyright (c) 2024 Contributors to the Eclipse Foundation
//
// See the NOTICE file(s) distributed with this work for additional
// information regarding copyright ownership.
//
// This program and the accompanying materials are made available under the
// terms of the Apache Software License 2.0 which is available at
// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
// which is available at https://opensource.org/licenses/MIT.
//
// SPDX-License-Identifier: Apache-2.0 OR MIT
 
#ifndef IOX2_ATTRIBUTE_SET_HPP
#define IOX2_ATTRIBUTE_SET_HPP
 
#include "iox2/attribute.hpp"
#include "iox2/bb/optional.hpp"
#include "iox2/bb/static_function.hpp"
#include "iox2/internal/iceoryx2.hpp"
 
#include <iostream>
 
namespace iox2 {
class AttributeSet;
 
class AttributeSetView {
  public:
    auto number_of_attributes() const -> uint64_t;
 
    auto operator[](uint64_t index) const -> AttributeView;
 
    auto number_of_key_values(const Attribute::Key& key) const -> uint64_t;
 
    auto key_value(const Attribute::Key& key, uint64_t idx) -> bb::Optional<Attribute::Value>;
 
    void iter_key_values(const Attribute::Key& key,
                         const iox2::bb::StaticFunction<CallbackProgression(const Attribute::Value&)>& callback) const;
 
    auto to_owned() const -> AttributeSet;
 
  private:
    template <ServiceType, typename, typename>
    friend class PortFactoryPublishSubscribe;
    template <ServiceType, typename, typename, typename, typename>
    friend class PortFactoryRequestResponse;
    template <ServiceType>
    friend class PortFactoryEvent;
    template <ServiceType, typename>
    friend class PortFactoryBlackboard;
    friend class AttributeVerifier;
    friend class AttributeSpecifier;
    friend class StaticConfig;
    friend class AttributeSet;
 
    explicit AttributeSetView(iox2_attribute_set_ptr handle);
 
    iox2_attribute_set_ptr m_handle = nullptr;
};
 
class AttributeSet {
  public:
    AttributeSet(const AttributeSet&) = delete;
    AttributeSet(AttributeSet&& rhs) noexcept;
    auto operator=(const AttributeSet&) -> AttributeSet& = delete;
    auto operator=(AttributeSet&& rhs) noexcept -> AttributeSet&;
    ~AttributeSet();
 
    auto number_of_attributes() const -> uint64_t;
 
    auto operator[](uint64_t index) const -> AttributeView;
 
    auto number_of_key_values(const Attribute::Key& key) const -> uint64_t;
 
    auto key_value(const Attribute::Key& key, uint64_t idx) -> bb::Optional<Attribute::Value>;
 
    void iter_key_values(const Attribute::Key& key,
                         const iox2::bb::StaticFunction<CallbackProgression(const Attribute::Value&)>& callback) const;
 
  private:
    friend class AttributeSetView;
 
    explicit AttributeSet(iox2_attribute_set_h handle);
    void drop();
 
    iox2_attribute_set_h m_handle = nullptr;
    AttributeSetView m_view;
};
 
} // namespace iox2
 
auto operator<<(std::ostream& stream, const iox2::AttributeSetView& value) -> std::ostream&;
auto operator<<(std::ostream& stream, const iox2::AttributeSet& value) -> std::ostream&;
 
#endif