Class
List
Hierarchy
Links
SDF Website
Report Documentation Issues
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  class Root;
42 
46  SDFORMAT_VISIBLE
47  bool init(SDFPtr _sdf);
48 
53  SDFORMAT_VISIBLE
54  bool initFile(const std::string &_filename, SDFPtr _sdf);
55 
61  SDFORMAT_VISIBLE
62  bool initFile(
63  const std::string &_filename, const ParserConfig &_config, SDFPtr _sdf);
64 
69  SDFORMAT_VISIBLE
70  bool initFile(const std::string &_filename, ElementPtr _sdf);
71 
77  SDFORMAT_VISIBLE
78  bool initFile(const std::string &_filename, const ParserConfig &_config,
79  ElementPtr _sdf);
80 
85  SDFORMAT_VISIBLE
86  bool initString(const std::string &_xmlString, SDFPtr _sdf);
87 
93  SDFORMAT_VISIBLE
94  bool initString(
95  const std::string &_xmlString, const ParserConfig &_config, SDFPtr _sdf);
96 
104  SDFORMAT_VISIBLE
105  sdf::SDFPtr readFile(const std::string &_filename);
106 
115  SDFORMAT_VISIBLE
116  sdf::SDFPtr readFile(const std::string &_filename, Errors &_errors);
117 
127  SDFORMAT_VISIBLE
128  sdf::SDFPtr readFile(const std::string &_filename,
129  const ParserConfig &_config, Errors &_errors);
130 
140  SDFORMAT_VISIBLE
141  bool readFile(const std::string &_filename, SDFPtr _sdf, Errors &_errors);
142 
153  SDFORMAT_VISIBLE
154  bool readFile(const std::string &_filename, const ParserConfig &_config,
155  SDFPtr _sdf, Errors &_errors);
156 
168  SDFORMAT_VISIBLE
169  bool readFileWithoutConversion(
170  const std::string &_filename, SDFPtr _sdf, Errors &_errors);
171 
184  SDFORMAT_VISIBLE
185  bool readFileWithoutConversion(const std::string &_filename,
186  const ParserConfig &_config, SDFPtr _sdf, Errors &_errors);
187 
196  SDFORMAT_VISIBLE
197  bool readFile(const std::string &_filename, SDFPtr _sdf);
198 
208  SDFORMAT_VISIBLE
209  bool readString(const std::string &_xmlString, SDFPtr _sdf, Errors &_errors);
210 
221  SDFORMAT_VISIBLE
222  bool readString(const std::string &_xmlString, const ParserConfig &_config,
223  SDFPtr _sdf, Errors &_errors);
224 
233  SDFORMAT_VISIBLE
234  bool readString(const std::string &_xmlString, SDFPtr _sdf);
235 
245  SDFORMAT_VISIBLE
246  bool readString(const std::string &_xmlString, ElementPtr _sdf,
247  Errors &_errors);
248 
259  SDFORMAT_VISIBLE
260  bool readString(const std::string &_xmlString, const ParserConfig &_config,
261  ElementPtr _sdf, Errors &_errors);
262 
274  SDFORMAT_VISIBLE
275  bool readStringWithoutConversion(
276  const std::string &_xmlString, SDFPtr _sdf, Errors &_errors);
277 
288  SDFORMAT_VISIBLE
289  bool readStringWithoutConversion(const std::string &_xmlString,
290  const ParserConfig &_config, SDFPtr _sdf, Errors &_errors);
291 
300  SDFORMAT_VISIBLE
301  bool readString(const std::string &_xmlString, ElementPtr _sdf);
302 
308  SDFORMAT_VISIBLE
309  std::string getModelFilePath(const std::string &_modelDirPath);
310 
316  SDFORMAT_VISIBLE
317  bool convertFile(const std::string &_filename, const std::string &_version,
318  SDFPtr _sdf);
319 
326  SDFORMAT_VISIBLE
327  bool convertFile(const std::string &_filename, const std::string &_version,
328  const ParserConfig &_config, SDFPtr _sdf);
329 
335  SDFORMAT_VISIBLE
336  bool convertString(const std::string &_sdfString,
337  const std::string &_version, SDFPtr _sdf);
338 
345  SDFORMAT_VISIBLE
346  bool convertString(const std::string &_sdfString, const std::string &_version,
347  const ParserConfig &_config, SDFPtr _sdf);
348 
356  SDFORMAT_VISIBLE
357  bool checkCanonicalLinkNames(const sdf::Root *_root);
358 
367  SDFORMAT_VISIBLE
368  bool checkFrameAttachedToGraph(const sdf::Root *_root);
369 
378  SDFORMAT_VISIBLE
379  bool checkFrameAttachedToNames(const sdf::Root *_root);
380 
388  SDFORMAT_VISIBLE
389  bool checkJointParentChildLinkNames(const sdf::Root *_root);
390 
399  SDFORMAT_VISIBLE
400  bool checkPoseRelativeToGraph(const sdf::Root *_root);
401 
408  SDFORMAT_VISIBLE
409  bool recursiveSameTypeUniqueNames(sdf::ElementPtr _elem);
410 
417  SDFORMAT_VISIBLE
418  bool recursiveSiblingUniqueNames(sdf::ElementPtr _elem);
419 
427  SDFORMAT_VISIBLE
428  bool recursiveSiblingNoDoubleColonInNames(sdf::ElementPtr _elem);
429 
435  SDFORMAT_VISIBLE
436  bool shouldValidateElement(sdf::ElementPtr _elem);
437  }
438 }
439 #endif
sdf::v12::readStringWithoutConversion
bool readStringWithoutConversion(const std::string &_xmlString, SDFPtr _sdf, Errors &_errors)
Populate the SDF values from a string without converting to the latest SDF version.
sdf::v12::checkCanonicalLinkNames
bool checkCanonicalLinkNames(const sdf::Root *_root)
Check that for each model, the canonical_link attribute value matches the name of a link in the model...
sdf::v12::convertFile
bool convertFile(const std::string &_filename, const std::string &_version, SDFPtr _sdf)
Convert an SDF file to a specific SDF version.
sdf::v12::shouldValidateElement
bool shouldValidateElement(sdf::ElementPtr _elem)
Check whether the element should be validated.
sdf
namespace for Simulation Description Format parser
Definition: Actor.hh:33
sdf::v12::getModelFilePath
std::string getModelFilePath(const std::string &_modelDirPath)
Get the file path to the model file.
sdf::v12::recursiveSameTypeUniqueNames
bool recursiveSameTypeUniqueNames(sdf::ElementPtr _elem)
Check that all sibling elements of the same type have unique names.
sdf::v12::Errors
std::vector< Error > Errors
A vector of Error.
Definition: Types.hh:106
sdf::v12::initFile
bool initFile(const std::string &_filename, SDFPtr _sdf)
Initialize the SDF interface using a file.
sdf::v12::readFileWithoutConversion
bool readFileWithoutConversion(const std::string &_filename, SDFPtr _sdf, Errors &_errors)
Populate the SDF values from a file without converting to the latest SDF version.
SDFORMAT_VISIBLE
#define SDFORMAT_VISIBLE
Definition: system_util.hh:41
sdf::v12::SDFPtr
std::shared_ptr< SDF > SDFPtr
Definition: SDFImpl.hh:52
sdf::v12::checkFrameAttachedToGraph
bool checkFrameAttachedToGraph(const sdf::Root *_root)
For the world and each model, check that the attached_to graphs build without errors and have no cycl...
sdf::v12::init
bool init(SDFPtr _sdf)
Initialize the SDF interface from the embedded root spec file.
sdf::v12::initString
bool initString(const std::string &_xmlString, SDFPtr _sdf)
Initialize the SDF interface using a string.
sdf::v12::Root
Root class that acts as an entry point to the SDF document model.
Definition: Root.hh:54
sdf::v12::checkFrameAttachedToNames
bool checkFrameAttachedToNames(const sdf::Root *_root)
Check that for each frame, the attached_to attribute value does not match its own frame name but does...
SDFImpl.hh
sdf::v12::checkPoseRelativeToGraph
bool checkPoseRelativeToGraph(const sdf::Root *_root)
For the world and each model, check that the attached_to graphs build without errors and have no cycl...
sdf::v12::recursiveSiblingNoDoubleColonInNames
bool recursiveSiblingNoDoubleColonInNames(sdf::ElementPtr _elem)
Check that all sibling elements do not contain the delimiter double colons '::' in element names,...
sdf::v12::checkJointParentChildLinkNames
bool checkJointParentChildLinkNames(const sdf::Root *_root)
Check that all joints in contained models specify parent and child link names that match the names of...
system_util.hh
sdf::v12::readString
bool readString(const std::string &_xmlString, SDFPtr _sdf, Errors &_errors)
Populate the SDF values from a string.
sdf::v12::ElementPtr
std::shared_ptr< Element > ElementPtr
Definition: Element.hh:54
sdf::v12::recursiveSiblingUniqueNames
bool recursiveSiblingUniqueNames(sdf::ElementPtr _elem)
Check that all sibling elements of the any type have unique names.
sdf::v12::readFile
sdf::SDFPtr readFile(const std::string &_filename)
Populate the SDF values from a file.
sdf::v12::convertString
bool convertString(const std::string &_sdfString, const std::string &_version, SDFPtr _sdf)
Convert an SDF string to a specific SDF version.