.. _program_listing_file__tmp_ws_src_fastrtps_include_fastrtps_types_DynamicTypeBuilder.h:

Program Listing for File DynamicTypeBuilder.h
=============================================

|exhale_lsh| :ref:`Return to documentation for file <file__tmp_ws_src_fastrtps_include_fastrtps_types_DynamicTypeBuilder.h>` (``/tmp/ws/src/fastrtps/include/fastrtps/types/DynamicTypeBuilder.h``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   // Copyright 2018 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 TYPES_DYNAMIC_TYPE_BUILDER_H
   #define TYPES_DYNAMIC_TYPE_BUILDER_H
   
   #include <fastrtps/types/TypesBase.h>
   #include <fastrtps/types/DynamicTypePtr.h>
   
   namespace eprosima {
   namespace fastrtps {
   namespace types {
   
   class AnnotationDescriptor;
   class TypeDescriptor;
   class MemberDescriptor;
   class DynamicType;
   class DynamicTypeMember;
   
   class DynamicTypeBuilder
   {
   protected:
       DynamicTypeBuilder();
   
       DynamicTypeBuilder(const DynamicTypeBuilder* builder);
   
       DynamicTypeBuilder(const TypeDescriptor* descriptor);
   
       virtual ~DynamicTypeBuilder();
   
       friend class DynamicType;
       friend class DynamicTypeBuilderFactory;
   
       TypeDescriptor* descriptor_;
       std::map<MemberId, DynamicTypeMember*> member_by_id_;         // Aggregated members
       std::map<std::string, DynamicTypeMember*> member_by_name_;    // Uses the pointers from "member_by_id_".
       std::string name_;
       TypeKind kind_;
       MemberId current_member_id_;
       uint32_t max_index_;
   
       ReturnCode_t _apply_annotation_to_member(
               MemberId id,
               AnnotationDescriptor& descriptor);
   
       ReturnCode_t _apply_annotation_to_member(
               MemberId id,
               const std::string& annotation_name,
               const std::string& key,
               const std::string& value);
   
       bool check_union_configuration(const MemberDescriptor* descriptor);
   
       // Checks if there is a member with the given name.
       bool exists_member_by_name(const std::string& name) const;
   
       void refresh_member_ids();
   
       void clear();
   
       ReturnCode_t copy_from_builder(const DynamicTypeBuilder* other);
   
   public:
       RTPS_DllAPI ReturnCode_t add_empty_member(
               uint32_t index,
               const std::string& name);
   
       RTPS_DllAPI ReturnCode_t add_member(const MemberDescriptor* descriptor);
   
       RTPS_DllAPI ReturnCode_t add_member(
               MemberId id,
               const std::string& name,
               DynamicTypeBuilder* type_ = nullptr);
   
       RTPS_DllAPI ReturnCode_t add_member(
               MemberId id,
               const std::string& name,
               DynamicTypeBuilder* type_,
               const std::string& defaultValue);
   
       RTPS_DllAPI ReturnCode_t add_member(
               MemberId id,
               const std::string& name,
               DynamicTypeBuilder* type_,
               const std::string& defaultValue,
               const std::vector<uint64_t>& unionLabels,
               bool isDefaultLabel);
   
       RTPS_DllAPI ReturnCode_t add_member(
               MemberId id,
               const std::string& name,
           DynamicType_ptr type_ = DynamicType_ptr(nullptr));
   
       RTPS_DllAPI ReturnCode_t add_member(
               MemberId id,
               const std::string& name,
               DynamicType_ptr type_,
               const std::string& defaultValue);
   
       RTPS_DllAPI ReturnCode_t add_member(
               MemberId id,
               const std::string& name,
               DynamicType_ptr type_,
               const std::string& defaultValue,
               const std::vector<uint64_t>& unionLabels,
               bool isDefaultLabel);
   
       RTPS_DllAPI ReturnCode_t apply_annotation(AnnotationDescriptor& descriptor);
   
       RTPS_DllAPI ReturnCode_t apply_annotation(
               const std::string& annotation_name,
               const std::string& key,
               const std::string& value);
   
       RTPS_DllAPI ReturnCode_t apply_annotation_to_member(
               MemberId id,
               AnnotationDescriptor& descriptor);
   
       RTPS_DllAPI ReturnCode_t apply_annotation_to_member(
               MemberId id,
               const std::string& annotation_name,
               const std::string& key,
               const std::string& value);
   
       RTPS_DllAPI DynamicType_ptr build();
   
       RTPS_DllAPI ReturnCode_t copy_from(const DynamicTypeBuilder* other);
   
       ReturnCode_t get_all_members(std::map<MemberId, DynamicTypeMember*>& members);
   
       RTPS_DllAPI inline TypeKind get_kind() const
       {
           return kind_;
       }
   
       RTPS_DllAPI std::string get_name() const;
   
       RTPS_DllAPI MemberId get_member_id_by_name(const std::string& name) const;
   
       const TypeDescriptor* get_type_descriptor() const
       {
           return descriptor_;
       }
   
       bool is_consistent() const;
   
       bool is_discriminator_type() const;
   
       RTPS_DllAPI ReturnCode_t set_name(const std::string& name);
   };
   
   } // namespace types
   } // namespace fastrtps
   } // namespace eprosima
   
   #endif // TYPES_DYNAMIC_TYPE_BUILDER_H