DynamicTypeBuilder.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__DYNAMICTYPEBUILDER_HPP
#define FASTDDS_DDS_XTYPES_DYNAMIC_TYPES__DYNAMICTYPEBUILDER_HPP
 
#include <memory>
 
#include <fastdds/dds/core/ReturnCode.hpp>
#include <fastdds/dds/xtypes/dynamic_types/AnnotationDescriptor.hpp>
#include <fastdds/dds/xtypes/dynamic_types/DynamicTypeMember.hpp>
#include <fastdds/dds/xtypes/dynamic_types/TypeDescriptor.hpp>
#include <fastdds/dds/xtypes/dynamic_types/Types.hpp>
#include <fastdds/fastdds_dll.hpp>
 
namespace eprosima {
namespace fastdds {
namespace dds {
 
class DynamicTypeBuilder : public std::enable_shared_from_this<DynamicTypeBuilder>
{
public:
 
    using _ref_type = typename traits<DynamicTypeBuilder>::ref_type;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_descriptor(
            traits<TypeDescriptor>::ref_type& descriptor) = 0;
 
    FASTDDS_EXPORTED_API virtual ObjectName get_name() = 0;
 
    FASTDDS_EXPORTED_API virtual TypeKind get_kind() = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_member_by_name(
            traits<DynamicTypeMember>::ref_type& member,
            const ObjectName& name) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_all_members_by_name(
            DynamicTypeMembersByName& member) = 0;
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_member(
            traits<DynamicTypeMember>::ref_type& member,
            MemberId id) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_all_members(
            DynamicTypeMembersById& member) = 0;
 
    FASTDDS_EXPORTED_API virtual uint32_t get_member_count() = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_member_by_index(
            traits<DynamicTypeMember>::ref_type& member,
            uint32_t index) = 0;
 
    FASTDDS_EXPORTED_API virtual uint32_t get_annotation_count() = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_annotation(
            traits<AnnotationDescriptor>::ref_type& descriptor,
            uint32_t idx) = 0;
 
    FASTDDS_EXPORTED_API virtual bool equals(
            traits<DynamicType>::ref_type other) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t add_member(
            traits<MemberDescriptor>::ref_type descriptor) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t apply_annotation(
            traits<AnnotationDescriptor>::ref_type descriptor) = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t apply_annotation_to_member(
            MemberId member_id,
            traits<AnnotationDescriptor>::ref_type descriptor) = 0;
 
    FASTDDS_EXPORTED_API virtual traits<DynamicType>::ref_type build() = 0;
 
protected:
 
    DynamicTypeBuilder() = default;
 
    virtual ~DynamicTypeBuilder() = default;
 
    traits<DynamicTypeBuilder>::ref_type _this();
 
private:
 
    DynamicTypeBuilder(
            const DynamicTypeBuilder&) = delete;
 
    DynamicTypeBuilder(
            DynamicTypeBuilder&&) = delete;
 
    DynamicTypeBuilder& operator =(
            const DynamicTypeBuilder&) = delete;
 
    DynamicTypeBuilder& operator =(
            DynamicTypeBuilder&&) = delete;
};
 
} // namespace dds
} // namespace fastdds
} // namespace eprosima
 
#endif // FASTDDS_DDS_XTYPES_DYNAMIC_TYPES__DYNAMICTYPEBUILDER_HPP