DynamicTypeMember.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__DYNAMICTYPEMEMBER_HPP
#define FASTDDS_DDS_XTYPES_DYNAMIC_TYPES__DYNAMICTYPEMEMBER_HPP
 
#include <map>
#include <memory>
 
#include <fastdds/dds/core/ReturnCode.hpp>
#include <fastdds/dds/xtypes/dynamic_types/AnnotationDescriptor.hpp>
#include <fastdds/dds/xtypes/dynamic_types/MemberDescriptor.hpp>
#include <fastdds/dds/xtypes/dynamic_types/Types.hpp>
#include <fastdds/dds/xtypes/dynamic_types/VerbatimTextDescriptor.hpp>
#include <fastdds/fastdds_dll.hpp>
 
namespace eprosima {
namespace fastdds {
namespace dds {
 
class DynamicTypeMember : public std::enable_shared_from_this<DynamicTypeMember>
{
public:
 
    using _ref_type = typename traits<DynamicTypeMember>::ref_type;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_descriptor(
            traits<MemberDescriptor>::ref_type& descriptor) = 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 uint32_t get_verbatim_text_count() = 0;
 
    FASTDDS_EXPORTED_API virtual ReturnCode_t get_verbatim_text(
            traits<VerbatimTextDescriptor>::ref_type& descriptor,
            uint32_t idx) = 0;
 
    FASTDDS_EXPORTED_API virtual bool equals(
            traits<DynamicTypeMember>::ref_type other) = 0;
 
    FASTDDS_EXPORTED_API virtual MemberId get_id()  = 0;
 
    FASTDDS_EXPORTED_API virtual ObjectName get_name() = 0;
 
protected:
 
    DynamicTypeMember() = default;
 
    virtual ~DynamicTypeMember() = default;
 
    traits<DynamicTypeMember>::ref_type _this();
 
private:
 
    DynamicTypeMember(
            const DynamicTypeMember&) = delete;
 
    DynamicTypeMember(
            DynamicTypeMember&&) = delete;
 
    DynamicTypeMember& operator =(
            const DynamicTypeMember&) = delete;
 
    DynamicTypeMember& operator =(
            DynamicTypeMember&&) = delete;
};
 
typedef std::map<ObjectName, traits<DynamicTypeMember>::ref_type> DynamicTypeMembersByName;
 
typedef std::map<MemberId, traits<DynamicTypeMember>::ref_type> DynamicTypeMembersById;
 
} // namespace dds
} // namespace fastdds
} // namespace eprosima
 
#endif // FASTDDS_DDS_XTYPES_DYNAMIC_TYPES__DYNAMICTYPEMEMBER_HPP