Fast RTPS  Version 2.1.0
Fast RTPS
TypeDescriptor.h
1 // Copyright 2018 Proyectos y Sistemas de Mantenimiento SL (eProsima).
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #ifndef TYPES_TYPE_DESCRIPTOR_H
16 #define TYPES_TYPE_DESCRIPTOR_H
17 
18 #include <fastrtps/types/TypesBase.h>
19 #include <fastrtps/types/DynamicTypePtr.h>
20 
21 class MemberDescriptor;
22 class DynamicType;
23 
24 namespace eprosima {
25 namespace fastrtps {
26 namespace types {
27 
29 {
30 protected:
31  TypeKind kind_; // Type Kind.
32  std::string name_; // Type Name.
33  DynamicType_ptr base_type_; // SuperType of an structure or base type of an alias type.
34  DynamicType_ptr discriminator_type_; // Discrimination type for a union.
35  std::vector<uint32_t> bound_; // Length for strings, arrays, sequences, maps and bitmasks.
36  DynamicType_ptr element_type_; // Value Type for arrays, sequences, maps, bitmasks.
37  DynamicType_ptr key_element_type_; // Key Type for maps.
38  std::vector<AnnotationDescriptor*> annotation_; // Annotations to apply
39 
40  void clean();
41 
42  bool is_type_name_consistent(const std::string& sName) const;
43 
45  friend class TypeObjectFactory;
46  friend class DynamicType;
47  friend class MemberDescriptor;
48  friend class DynamicDataHelper;
49 
50 public:
52 
54 
56  const std::string& name,
57  TypeKind kind);
58 
60 
62 
63  bool equals(const TypeDescriptor* descriptor) const;
64 
65  bool is_consistent() const;
66 
68 
69  uint32_t get_bounds(uint32_t index = 0) const;
70 
71  uint32_t get_bounds_size() const;
72 
74 
76 
78 
79  TypeKind get_kind() const;
80 
81  std::string get_name() const;
82 
83  uint32_t get_total_bounds() const;
84 
85  void set_kind(TypeKind kind);
86 
87  void set_name(std::string name);
88 
90 
92  const std::string& annotation_name,
93  const std::string& key,
94  const std::string& value);
95 
96  AnnotationDescriptor* get_annotation(const std::string& name) const;
97 
98  // Annotations application
100 
101  bool annotation_is_mutable() const;
102 
103  bool annotation_is_final() const;
104 
106 
107  bool annotation_is_nested() const;
108 
110 
111  bool annotation_is_key() const;
112 
114 
115  // Annotation getters
116  std::string annotation_get_extensibility() const;
117 
118  bool annotation_get_nested() const;
119 
120  uint16_t annotation_get_bit_bound() const;
121 
122  bool annotation_get_key() const;
123 
124  // Annotation setters
125  void annotation_set_extensibility(const std::string& extensibility);
126 
128 
130 
132 
133  void annotation_set_nested(bool nested);
134 
135  void annotation_set_bit_bound(uint16_t bit_bound);
136 
137  void annotation_set_key(bool key);
138 
139  void annotation_set_non_serialized(bool non_serialized);
140 };
141 
142 } // namespace types
143 } // namespace fastrtps
144 } // namespace eprosima
145 
146 #endif // TYPES_TYPE_DESCRIPTOR_H
Definition: AnnotationDescriptor.h:29
Definition: DynamicDataHelper.hpp:30
Definition: DynamicTypePtr.h:27
Definition: DynamicTypeBuilderFactory.h:40
Definition: DynamicType.h:38
Definition: MemberDescriptor.h:29
Definition: TypesBase.h:204
Definition: TypeDescriptor.h:29
DynamicType_ptr get_discriminator_type() const
void annotation_set_bit_bound(uint16_t bit_bound)
bool equals(const TypeDescriptor *descriptor) const
void annotation_set_extensibility(const std::string &extensibility)
ReturnCode_t apply_annotation(AnnotationDescriptor &descriptor)
std::string name_
Definition: TypeDescriptor.h:32
TypeDescriptor(const std::string &name, TypeKind kind)
TypeDescriptor(const TypeDescriptor *other)
DynamicType_ptr discriminator_type_
Definition: TypeDescriptor.h:34
uint32_t get_bounds(uint32_t index=0) const
DynamicType_ptr get_key_element_type() const
bool is_type_name_consistent(const std::string &sName) const
DynamicType_ptr key_element_type_
Definition: TypeDescriptor.h:37
TypeKind kind_
Definition: TypeDescriptor.h:31
ReturnCode_t apply_annotation(const std::string &annotation_name, const std::string &key, const std::string &value)
ReturnCode_t copy_from(const TypeDescriptor *descriptor)
DynamicType_ptr base_type_
Definition: TypeDescriptor.h:33
std::string annotation_get_extensibility() const
std::vector< uint32_t > bound_
Definition: TypeDescriptor.h:35
void annotation_set_non_serialized(bool non_serialized)
DynamicType_ptr get_element_type() const
std::vector< AnnotationDescriptor * > annotation_
Definition: TypeDescriptor.h:38
DynamicType_ptr element_type_
Definition: TypeDescriptor.h:36
AnnotationDescriptor * get_annotation(const std::string &name) const
Definition: TypeObjectFactory.h:29
octet TypeKind
Definition: TypesBase.h:115
eProsima namespace.
Definition: LibrarySettingsAttributes.h:23
Definition: BuiltinAnnotationsTypeObject.h:73