parser.hh
Go to the documentation of this file.
1 /*
2  * Copyright 2012 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 #ifndef SDF_PARSER_HH_
18 #define SDF_PARSER_HH_
19 
20 #include <string>
21 
22 #include "sdf/SDFImpl.hh"
23 #include "sdf/sdf_config.h"
24 #include "sdf/system_util.hh"
25 
36 namespace sdf
37 {
38  // Inline bracket to help doxygen filtering.
39  inline namespace SDF_VERSION_NAMESPACE {
40  //
41 
44  bool init(SDFPtr _sdf);
45 
48  bool initFile(const std::string &_filename, SDFPtr _sdf);
49 
52  bool initFile(const std::string &_filename, ElementPtr _sdf);
53 
56  bool initString(const std::string &_xmlString, SDFPtr _sdf);
57 
62  sdf::SDFPtr readFile(const std::string &_filename);
63 
69  sdf::SDFPtr readFile(const std::string &_filename, Errors &_errors);
70 
81  bool readFile(const std::string &_filename, SDFPtr _sdf, Errors &_errors);
82 
92  bool readFile(const std::string &_filename, SDFPtr _sdf);
93 
101  bool readString(const std::string &_xmlString, SDFPtr _sdf, Errors &_errors);
102 
109  bool readString(const std::string &_xmlString, SDFPtr _sdf);
110 
118  bool readString(const std::string &_xmlString, ElementPtr _sdf,
119  Errors &_errors);
120 
127  bool readString(const std::string &_xmlString, ElementPtr _sdf);
128 
135  std::string getModelFilePath(const std::string &_modelDirPath);
136 
138  void addNestedModel(ElementPtr _sdf, ElementPtr _includeSDF);
139 
146  bool convertFile(const std::string &_filename, const std::string &_version,
147  SDFPtr _sdf);
148 
155  bool convertString(const std::string &_sdfString,
156  const std::string &_version, SDFPtr _sdf);
157  }
158 }
159 #endif
SDFORMAT_VISIBLE bool convertString(const std::string &_sdfString, const std::string &_version, SDFPtr _sdf)
Convert an SDF string to a specific SDF version.
SDFORMAT_VISIBLE bool readString(const std::string &_xmlString, ElementPtr _sdf)
Populate the SDF values from a string.
std::shared_ptr< Element > ElementPtr
Definition: Element.hh:51
SDFORMAT_VISIBLE bool convertFile(const std::string &_filename, const std::string &_version, SDFPtr _sdf)
Convert an SDF file to a specific SDF version.
std::vector< Error > Errors
A vector of Error.
Definition: Types.hh:74
SDFORMAT_VISIBLE bool readFile(const std::string &_filename, SDFPtr _sdf)
Populate the SDF values from a file.
SDFORMAT_VISIBLE std::string getModelFilePath(const std::string &_modelDirPath)
Get the file path to the model file.
#define SDFORMAT_VISIBLE
Use to represent "symbol visible" if supported.
Definition: system_util.hh:48
std::shared_ptr< SDF > SDFPtr
Definition: SDFImpl.hh:50
SDFORMAT_VISIBLE bool initString(const std::string &_xmlString, SDFPtr _sdf)
Initialize the SDF interface using a string.
SDFORMAT_VISIBLE bool initFile(const std::string &_filename, ElementPtr _sdf)
Initialize an SDFElement interface using a file.
namespace for Simulation Description Format parser
Definition: AirPressure.hh:25
SDFORMAT_VISIBLE bool init(SDFPtr _sdf)
Init based on the installed sdf_format.xml file.
SDFORMAT_VISIBLE void addNestedModel(ElementPtr _sdf, ElementPtr _includeSDF)