ParserConfig.hh
Go to the documentation of this file.
1 /*
2  * Copyright 2020 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 
18 #ifndef SDF_PARSER_CONFIG_HH_
19 #define SDF_PARSER_CONFIG_HH_
20 
21 #include <functional>
22 #include <map>
23 #include <string>
24 #include <vector>
25 
26 #include <gz/utils/ImplPtr.hh>
27 
28 #include "sdf/Error.hh"
29 #include "sdf/InterfaceElements.hh"
31 #include "sdf/sdf_config.h"
32 #include "sdf/system_util.hh"
33 
34 
35 namespace sdf
36 {
37 inline namespace SDF_VERSION_NAMESPACE
38 {
41 {
43  ERR,
44 
46  WARN,
47 
49  LOG,
50 };
51 
56 {
60 
64 
70 };
71 
72 // Forward declare private data class.
73 class ParserConfigPrivate;
74 
106 {
108  public: using SchemeToPathMap =
109  std::map<std::string, std::vector<std::string> >;
110 
112  public: ParserConfig();
113 
118  public: static ParserConfig &GlobalConfig();
119 
122  public: const std::function<std::string(const std::string &)> &
124 
138  public: void SetFindCallback(
139  std::function<std::string(const std::string &)> _cb);
140 
143  public: const SchemeToPathMap &URIPathMap() const;
144 
150  public: void AddURIPath(const std::string &_uri, const std::string &_path);
151 
154  public: void SetWarningsPolicy(EnforcementPolicy _policy);
155 
159 
163 
167 
171 
175 
183 
188 
193  ConfigureResolveAutoInertials _configuration);
194 
198  public: void RegisterCustomModelParser(CustomModelParser _modelParser);
199 
202  public: const std::vector<CustomModelParser> &CustomModelParsers() const;
203 
208  CustomInertiaCalculator _inertiaCalculator);
209 
213 
217  public: void URDFSetPreserveFixedJoint(bool _preserveFixedJoint);
218 
222  public: bool URDFPreserveFixedJoint() const;
223 
226  public: void SetStoreResovledURIs(bool _resolveURI);
227 
237  public: void SetStoreResolvedURIs(bool _resolveURI);
238 
242  public: bool StoreResolvedURIs() const;
243 
245  GZ_UTILS_IMPL_PTR(dataPtr)
246 };
247 }
248 }
249 
250 #endif
This class contains configuration options for the libsdformat parser.
Definition: ParserConfig.hh:106
const CustomInertiaCalculator & CustomInertiaCalc() const
Get the registered custom mesh MOI Calculator.
void AddURIPath(const std::string &_uri, const std::string &_path)
Associate paths to a URI.
void URDFSetPreserveFixedJoint(bool _preserveFixedJoint)
Set the preserveFixedJoint flag.
void ResetDeprecatedElementsPolicy()
Resets the policy for deprecated elements so that it follows WarningsPolicy.
void SetDeprecatedElementsPolicy(EnforcementPolicy _policy)
Set the policy for deprecated elements.
void SetUnrecognizedElementsPolicy(EnforcementPolicy _policy)
Set the policy for unrecogonized elements without an xmlns.
void SetFindCallback(std::function< std::string(const std::string &)> _cb)
Set the callback to use when libsdformat can't find a file.
static ParserConfig & GlobalConfig()
Mutable access to a singleton ParserConfig that serves as the global ParserConfig object for all pars...
const std::vector< CustomModelParser > & CustomModelParsers() const
Get the registered custom model parsers.
void SetStoreResolvedURIs(bool _resolveURI)
Set the storeResolvedURIs flag value.
void RegisterCustomModelParser(CustomModelParser _modelParser)
Registers a custom model parser.
EnforcementPolicy UnrecognizedElementsPolicy() const
Get the current unrecognized elements policy.
std::map< std::string, std::vector< std::string > > SchemeToPathMap
type alias for the map from URI scheme to search directories
Definition: ParserConfig.hh:109
EnforcementPolicy WarningsPolicy() const
Get the current warning enforcement policy.
ConfigureResolveAutoInertials CalculateInertialConfiguration() const
Get the current configuration for the CalculateInertial() function.
void SetWarningsPolicy(EnforcementPolicy _policy)
Set the warning enforcment policy.
const SchemeToPathMap & URIPathMap() const
Get the URI scheme to search directories map.
bool URDFPreserveFixedJoint() const
Get the preserveFixedJoint flag value.
bool StoreResolvedURIs() const
Get the storeResolvedURIs flag value.
void SetStoreResovledURIs(bool _resolveURI)
Set the storeResolvedURIs flag value.
const std::function< std::string(const std::string &)> & FindFileCallback() const
Get the find file callback function.
EnforcementPolicy DeprecatedElementsPolicy() const
Get the current deprecated elements policy.
void SetCalculateInertialConfiguration(ConfigureResolveAutoInertials _configuration)
Set the configuration for the CalculateInertial() function.
void RegisterCustomInertiaCalc(CustomInertiaCalculator _inertiaCalculator)
Registers a custom Moment of Inertia Calculator for Meshes.
EnforcementPolicy
Policy to describe how to treat certain conditions when parsing.
Definition: ParserConfig.hh:41
@ WARN
Treat condition as a warning and issue to user.
@ LOG
Ignore condition in favor of best effort parsing.
@ ERR
Policy is to treat condition as an error and fail parsing.
std::function< sdf::InterfaceModelPtr(const sdf::NestedInclude &, Errors &)> CustomModelParser
Defines a custom model parser.
Definition: InterfaceElements.hh:198
ConfigureResolveAutoInertials
Configuration options of how CalculateInertial() function would be used.
Definition: ParserConfig.hh:56
@ SAVE_CALCULATION
If this values is used, CalculateInertial() would be called and the computed inertial values would be...
@ SKIP_CALCULATION_IN_LOAD
If this value is used, CalculateInertial() won't be called from inside the Root::Load() function.
@ SAVE_CALCULATION_IN_ELEMENT
If this values is used, CalculateInertial() would be called and the computed inertial values would be...
std::function< std::optional< gz::math::Inertiald >(sdf::Errors &, const sdf::CustomInertiaCalcProperties &)> CustomInertiaCalculator
Definition: CustomInertiaCalcProperties.hh:84
namespace for Simulation Description Format parser
Definition: Actor.hh:35
#define SDFORMAT_VISIBLE
Use to represent "symbol visible" if supported.
Definition: system_util.hh:25