Fast RTPS  Version 2.14.5
Fast RTPS
XMLProfileManager.h
1 // Copyright 2017 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 XML_PROFILE_MANAGER_H_
16 #define XML_PROFILE_MANAGER_H_
17 
18 #include <cstdio>
19 #include <map>
20 #include <string>
21 
22 #include <fastdds/dds/domain/qos/DomainParticipantFactoryQos.hpp>
23 #include <fastrtps/attributes/ParticipantAttributes.h>
24 #include <fastrtps/attributes/PublisherAttributes.h>
25 #include <fastrtps/attributes/SubscriberAttributes.h>
26 #include <fastrtps/types/DynamicPubSubType.h>
27 #include <fastrtps/types/DynamicTypeBuilder.h>
28 #include <fastrtps/types/DynamicTypeBuilderFactory.h>
29 #include <fastrtps/xmlparser/XMLParser.h>
30 #include <fastrtps/xmlparser/XMLParserCommon.h>
31 
32 namespace eprosima {
33 namespace fastrtps {
34 namespace xmlparser {
35 
36 using participant_factory_map_t = std::map<std::string, up_participantfactory_t>;
37 using part_factory_map_iterator_t = participant_factory_map_t::iterator;
38 using participant_map_t = std::map<std::string, up_participant_t>;
39 using part_map_iterator_t = participant_map_t::iterator;
40 using publisher_map_t = std::map<std::string, up_publisher_t>;
41 using publ_map_iterator_t = publisher_map_t::iterator;
42 using subscriber_map_t = std::map<std::string, up_subscriber_t>;
43 using subs_map_iterator_t = subscriber_map_t::iterator;
44 using topic_map_t = std::map<std::string, up_topic_t>;
45 using topic_map_iterator_t = topic_map_t::iterator;
46 using requester_map_t = std::map<std::string, up_requester_t>;
47 using requester_map_iterator_t = requester_map_t::iterator;
48 using replier_map_t = std::map<std::string, up_replier_t>;
49 using replier_map_iterator_t = replier_map_t::iterator;
50 using xmlfiles_map_t = std::map<std::string, XMLP_ret>;
51 using xmlfile_map_iterator_t = xmlfiles_map_t::iterator;
52 
58 {
59 public:
60 
64  RTPS_DllAPI static void loadDefaultXMLFile();
65 
72  RTPS_DllAPI static XMLP_ret loadXMLFile(
73  const std::string& filename);
74 
84  const std::string& filename,
85  bool is_default);
86 
94  RTPS_DllAPI static XMLP_ret loadXMLString(
95  const char* data,
96  size_t length);
97 
104  RTPS_DllAPI static XMLP_ret loadXMLNode(
105  tinyxml2::XMLDocument& doc);
106 
113  RTPS_DllAPI static XMLP_ret loadXMLProfiles(
114  tinyxml2::XMLElement& profiles);
115 
121  RTPS_DllAPI static XMLP_ret loadXMLDynamicTypes(
122  tinyxml2::XMLElement& types);
123 
128  RTPS_DllAPI static void library_settings(
130 
135  RTPS_DllAPI static const LibrarySettingsAttributes& library_settings();
136 
145  const std::string& profile_name,
146  ParticipantAttributes& atts,
147  bool log_error = true);
148 
150  RTPS_DllAPI static void getDefaultParticipantAttributes(
151  ParticipantAttributes& participant_attributes);
152 
161  const std::string& profile_name,
162  fastdds::dds::DomainParticipantFactoryQos& qos,
163  bool log_error = true);
164 
169  RTPS_DllAPI static void getDefaultDomainParticipantFactoryQos(
170  fastdds::dds::DomainParticipantFactoryQos& qos);
171 
179  RTPS_DllAPI static XMLP_ret fillPublisherAttributes(
180  const std::string& profile_name,
181  PublisherAttributes& atts,
182  bool log_error = true);
183 
185  RTPS_DllAPI static void getDefaultPublisherAttributes(
186  PublisherAttributes& publisher_attributes);
187 
195  RTPS_DllAPI static XMLP_ret fillSubscriberAttributes(
196  const std::string& profile_name,
197  SubscriberAttributes& atts,
198  bool log_error = true);
199 
201  RTPS_DllAPI static void getDefaultSubscriberAttributes(
202  SubscriberAttributes& subscriber_attributes);
203 
205  RTPS_DllAPI static bool insertTransportById(
206  const std::string& transport_id,
207  sp_transport_t transport);
208 
210  RTPS_DllAPI static sp_transport_t getTransportById(
211  const std::string& transport_id);
212 
219  RTPS_DllAPI static XMLP_ret fillTopicAttributes(
220  const std::string& profile_name,
221  TopicAttributes& atts);
222 
224  RTPS_DllAPI static void getDefaultTopicAttributes(
225  TopicAttributes& topic_attributes);
226 
228  RTPS_DllAPI static bool insertDynamicTypeByName(
229  const std::string& type_name,
231 
234  const std::string& type_name);
235 
236 
243  RTPS_DllAPI static XMLP_ret fillRequesterAttributes(
244  const std::string& profile_name,
245  RequesterAttributes& atts);
246 
253  RTPS_DllAPI static XMLP_ret fillReplierAttributes(
254  const std::string& profile_name,
255  ReplierAttributes& atts);
256 
262  RTPS_DllAPI static void DeleteInstance();
263 
270  const std::string& type_name);
271 
276  RTPS_DllAPI static void DeleteDynamicPubSubType(
278 
279 private:
280 
281  RTPS_DllAPI static XMLP_ret extractProfiles(
282  up_base_node_t properties,
283  const std::string& filename);
284 
285  RTPS_DllAPI static XMLP_ret extractDomainParticipantFactoryProfile(
286  up_base_node_t& profile,
287  const std::string& filename);
288 
289  RTPS_DllAPI static XMLP_ret extractParticipantProfile(
290  up_base_node_t& profile,
291  const std::string& filename);
292 
293  RTPS_DllAPI static XMLP_ret extractPublisherProfile(
294  up_base_node_t& profile,
295  const std::string& filename);
296 
297  RTPS_DllAPI static XMLP_ret extractSubscriberProfile(
298  up_base_node_t& profile,
299  const std::string& filename);
300 
301  RTPS_DllAPI static XMLP_ret extractTopicProfile(
302  up_base_node_t& profile,
303  const std::string& filename);
304 
305  RTPS_DllAPI static XMLP_ret extractRequesterProfile(
306  up_base_node_t& profile,
307  const std::string& filename);
308 
309  RTPS_DllAPI static XMLP_ret extractReplierProfile(
310  up_base_node_t& profile,
311  const std::string& filename);
312 
313  static BaseNode* root;
314 
315  static LibrarySettingsAttributes library_settings_;
316 
317  static participant_factory_map_t participant_factory_profiles_;
318 
319  static participant_map_t participant_profiles_;
320 
321  static publisher_map_t publisher_profiles_;
322 
323  static subscriber_map_t subscriber_profiles_;
324 
325  static topic_map_t topic_profiles_;
326 
327  static requester_map_t requester_profiles_;
328 
329  static replier_map_t replier_profiles_;
330 
331  static xmlfiles_map_t xml_files_;
332 
333  static sp_transport_map_t transport_profiles_;
334 
335  static p_dynamictype_map_t dynamic_types_;
336 };
337 
338 } /* xmlparser */
339 } /* namespace */
340 } /* namespace eprosima */
341 
342 #endif // ifndef XML_PROFILE_MANAGER_H_
Class LibraySettingsAttributes, used by the user to define the FastRTPS library behaviour.
Definition: LibrarySettingsAttributes.h:38
Class ParticipantAttributes, used by the user to define the attributes of a Participant.
Definition: ParticipantAttributes.h:35
Class PublisherAttributes, used by the user to define the attributes of a Publisher.
Definition: PublisherAttributes.h:41
Definition: ReplierAttributes.hpp:29
Definition: RequesterAttributes.hpp:29
Class SubscriberAttributes, used by the user to define the attributes of a Subscriber.
Definition: SubscriberAttributes.h:39
Class TopicAttributes, used by the user to define the attributes of the topic associated with a Publi...
Definition: TopicAttributes.h:36
Definition: DynamicPubSubType.h:29
Definition: DynamicTypeBuilder.h:32
Class XMLProfileManager, used to make available profiles from XML file.
Definition: XMLProfileManager.h:58
static RTPS_DllAPI XMLP_ret fillParticipantAttributes(const std::string &profile_name, ParticipantAttributes &atts, bool log_error=true)
Search for the profile specified and fill the structure.
static RTPS_DllAPI void library_settings(const LibrarySettingsAttributes &library_settings)
Library settings setter.
static RTPS_DllAPI void getDefaultTopicAttributes(TopicAttributes &topic_attributes)
Fills topic_attributes with the default values.
static RTPS_DllAPI XMLP_ret fillTopicAttributes(const std::string &profile_name, TopicAttributes &atts)
Search for the profile specified and fill the structure.
static RTPS_DllAPI types::DynamicPubSubType * CreateDynamicPubSubType(const std::string &type_name)
Retrieves a DynamicPubSubType for the given dynamic type name.
static RTPS_DllAPI void getDefaultParticipantAttributes(ParticipantAttributes &participant_attributes)
Fills participant_attributes with the default values.
static RTPS_DllAPI XMLP_ret loadXMLNode(tinyxml2::XMLDocument &doc)
Load a profiles XML node.
static RTPS_DllAPI XMLP_ret fillReplierAttributes(const std::string &profile_name, ReplierAttributes &atts)
Search for the profile specified and fill the structure.
static RTPS_DllAPI bool insertTransportById(const std::string &transport_id, sp_transport_t transport)
Add a new transport instance along with its id.
static RTPS_DllAPI bool insertDynamicTypeByName(const std::string &type_name, p_dynamictypebuilder_t type)
Add a new dynamic type instance along with its name.
static RTPS_DllAPI void loadDefaultXMLFile()
Load the default profiles XML file.
static RTPS_DllAPI void getDefaultPublisherAttributes(PublisherAttributes &publisher_attributes)
Fills publisher_attributes with the default values.
static RTPS_DllAPI XMLP_ret loadXMLDynamicTypes(tinyxml2::XMLElement &types)
Load a dynamic types XML node.
static RTPS_DllAPI const LibrarySettingsAttributes & library_settings()
Library settings getter.
static RTPS_DllAPI void getDefaultSubscriberAttributes(SubscriberAttributes &subscriber_attributes)
Fills subscriber_attributes with the default values.
static XMLP_ret loadXMLFile(const std::string &filename, bool is_default)
Load a profiles XML file.
static RTPS_DllAPI XMLP_ret fillPublisherAttributes(const std::string &profile_name, PublisherAttributes &atts, bool log_error=true)
Search for the profile specified and fill the structure.
static RTPS_DllAPI void DeleteDynamicPubSubType(types::DynamicPubSubType *type)
Deletes the given DynamicPubSubType previously created by calling XMLProfileManager::CreateDynamicPub...
static RTPS_DllAPI XMLP_ret fillDomainParticipantFactoryQos(const std::string &profile_name, fastdds::dds::DomainParticipantFactoryQos &qos, bool log_error=true)
Search for the profile specified and fill the structure.
static RTPS_DllAPI XMLP_ret fillRequesterAttributes(const std::string &profile_name, RequesterAttributes &atts)
Search for the profile specified and fill the structure.
static RTPS_DllAPI XMLP_ret loadXMLString(const char *data, size_t length)
Load a profiles XML string.
static RTPS_DllAPI XMLP_ret loadXMLFile(const std::string &filename)
Load a profiles XML file.
static RTPS_DllAPI void DeleteInstance()
Deletes the XMLProfileManager instance.
static RTPS_DllAPI XMLP_ret fillSubscriberAttributes(const std::string &profile_name, SubscriberAttributes &atts, bool log_error=true)
Search for the profile specified and fill the structure.
static RTPS_DllAPI sp_transport_t getTransportById(const std::string &transport_id)
Retrieves a transport instance by its id.
static RTPS_DllAPI void getDefaultDomainParticipantFactoryQos(fastdds::dds::DomainParticipantFactoryQos &qos)
Fills input domain participant factory qos with the default values.
static RTPS_DllAPI XMLP_ret loadXMLProfiles(tinyxml2::XMLElement &profiles)
Load a profiles XML node.
static RTPS_DllAPI p_dynamictypebuilder_t getDynamicTypeByName(const std::string &type_name)
Retrieves a transport instance by its name.
XMLP_ret
Enum class XMLP_ret, used to provide a strongly typed result from the operations within this module.
Definition: XMLParserCommon.h:27
topic_map_t::iterator topic_map_iterator_t
Definition: XMLProfileManager.h:45
std::map< std::string, up_participantfactory_t > participant_factory_map_t
Definition: XMLProfileManager.h:36
replier_map_t::iterator replier_map_iterator_t
Definition: XMLProfileManager.h:49
std::map< std::string, up_participant_t > participant_map_t
Definition: XMLProfileManager.h:38
participant_factory_map_t::iterator part_factory_map_iterator_t
Definition: XMLProfileManager.h:37
std::map< std::string, sp_transport_t > sp_transport_map_t
Definition: XMLParser.h:58
std::shared_ptr< fastdds::rtps::TransportDescriptorInterface > sp_transport_t
Definition: XMLParser.h:57
std::map< std::string, up_publisher_t > publisher_map_t
Definition: XMLProfileManager.h:40
std::map< std::string, up_subscriber_t > subscriber_map_t
Definition: XMLProfileManager.h:42
std::map< std::string, XMLP_ret > xmlfiles_map_t
Definition: XMLProfileManager.h:50
std::map< std::string, up_topic_t > topic_map_t
Definition: XMLProfileManager.h:44
xmlfiles_map_t::iterator xmlfile_map_iterator_t
Definition: XMLProfileManager.h:51
std::map< std::string, up_requester_t > requester_map_t
Definition: XMLProfileManager.h:46
std::map< std::string, p_dynamictypebuilder_t > p_dynamictype_map_t
Definition: XMLParser.h:60
requester_map_t::iterator requester_map_iterator_t
Definition: XMLProfileManager.h:47
std::map< std::string, up_replier_t > replier_map_t
Definition: XMLProfileManager.h:48
std::unique_ptr< BaseNode > up_base_node_t
Definition: XMLParser.h:49
participant_map_t::iterator part_map_iterator_t
Definition: XMLProfileManager.h:39
publisher_map_t::iterator publ_map_iterator_t
Definition: XMLProfileManager.h:41
subscriber_map_t::iterator subs_map_iterator_t
Definition: XMLProfileManager.h:43
eProsima namespace.
Definition: LibrarySettingsAttributes.h:23