Fast RTPS  Version 2.7.1
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 <fastrtps/attributes/ParticipantAttributes.h>
19#include <fastrtps/attributes/PublisherAttributes.h>
20#include <fastrtps/attributes/SubscriberAttributes.h>
21#include <fastrtps/xmlparser/XMLParserCommon.h>
22#include <fastrtps/xmlparser/XMLParser.h>
23#include <fastrtps/types/DynamicTypeBuilderFactory.h>
24#include <fastrtps/types/DynamicTypeBuilder.h>
25#include <fastrtps/types/DynamicPubSubType.h>
26
27#include <stdio.h>
28#include <string>
29#include <map>
30
31namespace eprosima {
32namespace fastrtps {
33namespace xmlparser {
34
35using participant_map_t = std::map<std::string, up_participant_t>;
36using part_map_iterator_t = participant_map_t::iterator;
37using publisher_map_t = std::map<std::string, up_publisher_t>;
38using publ_map_iterator_t = publisher_map_t::iterator;
39using subscriber_map_t = std::map<std::string, up_subscriber_t>;
40using subs_map_iterator_t = subscriber_map_t::iterator;
41using topic_map_t = std::map<std::string, up_topic_t>;
42using topic_map_iterator_t = topic_map_t::iterator;
43using requester_map_t = std::map<std::string, up_requester_t>;
44using requester_map_iterator_t = requester_map_t::iterator;
45using replier_map_t = std::map<std::string, up_replier_t>;
46using replier_map_iterator_t = replier_map_t::iterator;
47using xmlfiles_map_t = std::map<std::string, XMLP_ret>;
48using xmlfile_map_iterator_t = xmlfiles_map_t::iterator;
49
50
56{
57public:
58
62 RTPS_DllAPI static void loadDefaultXMLFile();
63
70 RTPS_DllAPI static XMLP_ret loadXMLFile(
71 const std::string& filename);
72
80 RTPS_DllAPI static XMLP_ret loadXMLString(
81 const char* data,
82 size_t length);
83
90 RTPS_DllAPI static XMLP_ret loadXMLNode(
91 tinyxml2::XMLDocument& doc);
92
99 RTPS_DllAPI static XMLP_ret loadXMLProfiles(
100 tinyxml2::XMLElement& profiles);
101
107 RTPS_DllAPI static XMLP_ret loadXMLDynamicTypes(
108 tinyxml2::XMLElement& types);
109
114 RTPS_DllAPI static void library_settings(
116
121 RTPS_DllAPI static const LibrarySettingsAttributes& library_settings();
122
131 const std::string& profile_name,
133 bool log_error = true);
134
136 RTPS_DllAPI static void getDefaultParticipantAttributes(
137 ParticipantAttributes& participant_attributes);
138
147 const std::string& profile_name,
149 bool log_error = true);
150
152 RTPS_DllAPI static void getDefaultPublisherAttributes(
153 PublisherAttributes& publisher_attributes);
154
163 const std::string& profile_name,
165 bool log_error = true);
166
168 RTPS_DllAPI static void getDefaultSubscriberAttributes(
169 SubscriberAttributes& subscriber_attributes);
170
172 RTPS_DllAPI static bool insertTransportById(
173 const std::string& transport_id,
174 sp_transport_t transport);
175
178 const std::string& transport_id);
179
186 RTPS_DllAPI static XMLP_ret fillTopicAttributes(
187 const std::string& profile_name,
188 TopicAttributes& atts);
189
191 RTPS_DllAPI static void getDefaultTopicAttributes(
192 TopicAttributes& topic_attributes);
193
195 RTPS_DllAPI static bool insertDynamicTypeByName(
196 const std::string& type_name,
198
201 const std::string& type_name);
202
203
211 const std::string& profile_name,
212 RequesterAttributes& atts);
213
220 RTPS_DllAPI static XMLP_ret fillReplierAttributes(
221 const std::string& profile_name,
222 ReplierAttributes& atts);
223
229 RTPS_DllAPI static void DeleteInstance()
230 {
231 participant_profiles_.clear();
232 publisher_profiles_.clear();
233 subscriber_profiles_.clear();
234 requester_profiles_.clear();
235 replier_profiles_.clear();
236 topic_profiles_.clear();
237 xml_files_.clear();
238 transport_profiles_.clear();
239 }
240
247 const std::string& type_name)
248 {
249 if (dynamic_types_.find(type_name) != dynamic_types_.end())
250 {
251 return new types::DynamicPubSubType(dynamic_types_[type_name]->build());
252 }
253 return nullptr;
254 }
255
260 RTPS_DllAPI static void DeleteDynamicPubSubType(
262 {
263 delete type;
264 }
265
266private:
267
268 RTPS_DllAPI static XMLP_ret extractProfiles(
269 up_base_node_t properties,
270 const std::string& filename);
271
272 RTPS_DllAPI static XMLP_ret extractParticipantProfile(
273 up_base_node_t& profile,
274 const std::string& filename);
275
276 RTPS_DllAPI static XMLP_ret extractPublisherProfile(
277 up_base_node_t& profile,
278 const std::string& filename);
279
280 RTPS_DllAPI static XMLP_ret extractSubscriberProfile(
281 up_base_node_t& profile,
282 const std::string& filename);
283
284 RTPS_DllAPI static XMLP_ret extractTopicProfile(
285 up_base_node_t& profile,
286 const std::string& filename);
287
288 RTPS_DllAPI static XMLP_ret extractRequesterProfile(
289 up_base_node_t& profile,
290 const std::string& filename);
291
292 RTPS_DllAPI static XMLP_ret extractReplierProfile(
293 up_base_node_t& profile,
294 const std::string& filename);
295
296 static BaseNode* root;
297
298 static LibrarySettingsAttributes library_settings_;
299
300 static participant_map_t participant_profiles_;
301
302 static publisher_map_t publisher_profiles_;
303
304 static subscriber_map_t subscriber_profiles_;
305
306 static topic_map_t topic_profiles_;
307
308 static requester_map_t requester_profiles_;
309
310 static replier_map_t replier_profiles_;
311
312 static xmlfiles_map_t xml_files_;
313
314 static sp_transport_map_t transport_profiles_;
315
316 static p_dynamictype_map_t dynamic_types_;
317};
318
319} /* xmlparser */
320} /* namespace */
321} /* namespace eprosima */
322
323#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:56
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 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 types::DynamicPubSubType * CreateDynamicPubSubType(const std::string &type_name)
Retrieves a DynamicPubSubType for the given dynamic type name.
Definition: XMLProfileManager.h:246
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 void getDefaultSubscriberAttributes(SubscriberAttributes &subscriber_attributes)
Fills subscriber_attributes with the default values.
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 const LibrarySettingsAttributes & library_settings()
Library settings getter.
static RTPS_DllAPI void DeleteDynamicPubSubType(types::DynamicPubSubType *type)
Deletes the given DynamicPubSubType previously created by calling XMLProfileManager::CreateDynamicPub...
Definition: XMLProfileManager.h:260
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.
Definition: XMLProfileManager.h:229
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 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.
topic_map_t::iterator topic_map_iterator_t
Definition: XMLProfileManager.h:42
replier_map_t::iterator replier_map_iterator_t
Definition: XMLProfileManager.h:46
std::map< std::string, up_participant_t > participant_map_t
Definition: XMLProfileManager.h:35
std::map< std::string, sp_transport_t > sp_transport_map_t
Definition: XMLParser.h:51
std::shared_ptr< fastdds::rtps::TransportDescriptorInterface > sp_transport_t
Definition: XMLParser.h:50
std::map< std::string, up_publisher_t > publisher_map_t
Definition: XMLProfileManager.h:37
std::map< std::string, up_subscriber_t > subscriber_map_t
Definition: XMLProfileManager.h:39
XMLP_ret
Enum class XMLP_ret, used to provide a strongly typed result from the operations within this module.
Definition: XMLParserCommon.h:27
std::map< std::string, XMLP_ret > xmlfiles_map_t
Definition: XMLProfileManager.h:47
std::map< std::string, up_topic_t > topic_map_t
Definition: XMLProfileManager.h:41
xmlfiles_map_t::iterator xmlfile_map_iterator_t
Definition: XMLProfileManager.h:48
std::map< std::string, up_requester_t > requester_map_t
Definition: XMLProfileManager.h:43
std::map< std::string, p_dynamictypebuilder_t > p_dynamictype_map_t
Definition: XMLParser.h:53
requester_map_t::iterator requester_map_iterator_t
Definition: XMLProfileManager.h:44
std::map< std::string, up_replier_t > replier_map_t
Definition: XMLProfileManager.h:45
std::unique_ptr< BaseNode > up_base_node_t
Definition: XMLParser.h:44
participant_map_t::iterator part_map_iterator_t
Definition: XMLProfileManager.h:36
publisher_map_t::iterator publ_map_iterator_t
Definition: XMLProfileManager.h:38
subscriber_map_t::iterator subs_map_iterator_t
Definition: XMLProfileManager.h:40
eProsima namespace.
Definition: LibrarySettingsAttributes.h:23