AnnotationDescriptor.hpp

// Copyright 2023 Proyectos y Sistemas de Mantenimiento SL (eProsima).
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#ifndef FASTDDS_DDS_XTYPES_DYNAMIC_TYPES__ANNOTATIONDESCRIPTOR_HPP
#define FASTDDS_DDS_XTYPES_DYNAMIC_TYPES__ANNOTATIONDESCRIPTOR_HPP
 
#include <fastdds/dds/core/ReturnCode.hpp>
#include <fastdds/dds/xtypes/dynamic_types/Types.hpp>
#include <fastdds/fastdds_dll.hpp>
 
namespace eprosima {
namespace fastdds {
namespace dds {
 
class DynamicType;
 
class FASTDDS_EXPORTED_API AnnotationDescriptor
{
public:
 
    using _ref_type = typename traits<AnnotationDescriptor>::ref_type;

    virtual traits<DynamicType>::ref_type type() const = 0;

    virtual traits<DynamicType>::ref_type& type() = 0;

    virtual void type(
            traits<DynamicType>::ref_type type) = 0;

    virtual ReturnCode_t get_value(
            ObjectName& value,
            const ObjectName& key) = 0;

    virtual ReturnCode_t get_all_value(
            Parameters& value) = 0;

    virtual ReturnCode_t set_value(
            const ObjectName& key,
            const ObjectName& value) = 0;

    virtual ReturnCode_t copy_from(
            traits<AnnotationDescriptor>::ref_type descriptor) = 0;

    virtual bool equals(
            traits<AnnotationDescriptor>::ref_type descriptor) = 0;

    virtual bool is_consistent() = 0;
 
protected:
 
    AnnotationDescriptor() = default;
 
    AnnotationDescriptor(
            const AnnotationDescriptor&) = default;
 
    AnnotationDescriptor(
            AnnotationDescriptor&&) = default;
 
    virtual ~AnnotationDescriptor() = default;
 
private:
 
    AnnotationDescriptor& operator =(
            const AnnotationDescriptor&) = delete;
 
    AnnotationDescriptor& operator =(
            AnnotationDescriptor&&) = delete;
};
 
} // namespace dds
} // namespace fastdds
} // namespace eprosima
 
#endif // FASTDDS_DDS_XTYPES_DYNAMIC_TYPES__ANNOTATIONDESCRIPTOR_HPP