Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
sdf Namespace Reference

namespace for Simulation Description Format parser More...

Namespaces

 filesystem
 
 internal
 Internal namespace.
 
 SDF_VERSION_NAMESPACE
 

Classes

class  Actor
 Provides a description of an actor. More...
 
class  AirPressure
 AirPressure contains information about a general purpose fluid pressure sensor. More...
 
class  AirSpeed
 AirSpeed contains information about a general purpose air speed sensor. More...
 
class  Altimeter
 Altimeter contains information about an altimeter sensor. More...
 
class  Animation
 Animation in Actor. More...
 
class  AssertionInternalError
 Class for generating Exceptions which come from sdf assertions. More...
 
class  Atmosphere
 The Atmosphere class contains information about an atmospheric model and related parameters such as temperature and pressure at sea level. More...
 
class  Box
 Box represents a box shape, and is usually accessed through a Geometry. More...
 
class  BulletFriction
 BulletFriction information for a friction. More...
 
class  Camera
 Information about a monocular camera sensor. More...
 
class  Capsule
 Capsule represents a capsule shape, and is usually accessed through a Geometry. More...
 
class  Collision
 A collision element descibes the collision properties associated with a link. More...
 
class  Cone
 Cone represents a cone shape, and is usually accessed through a Geometry. More...
 
class  Console
 Message, error, warning, and logging functionality. More...
 
class  ConsolePrivate
 
class  Contact
 Contact information for a surface. More...
 
class  ConvexDecomposition
 Convex decomposition. More...
 
class  CustomInertiaCalcProperties
 
class  Cylinder
 Cylinder represents a cylinder shape, and is usually accessed through a Geometry. More...
 
class  Element
 SDF Element class. More...
 
class  ElementPrivate
 
class  Ellipsoid
 Ellipsoid represents a ellipsoid shape, and is usually accessed through a Geometry. More...
 
class  Error
 
class  Exception
 Class for generating exceptions. More...
 
class  ForceTorque
 ForceTorque contains information about a force torque sensor. More...
 
class  Frame
 A Frame element descibes the properties associated with an explicit frame defined in a Model or World. More...
 
class  Friction
 Friction information for a surface. More...
 
class  Geometry
 Geometry provides access to a shape, such as a Box. More...
 
class  Gui
 
class  Heightmap
 Heightmap represents a shape defined by a 2D field, and is usually accessed through a Geometry. More...
 
class  HeightmapBlend
 Blend information to be used between textures on heightmaps. More...
 
class  HeightmapTexture
 Texture to be used on heightmaps. More...
 
class  Imu
 Imu contains information about an imu sensor. More...
 
class  InterfaceFrame
 Interface element representing an explicit frame. More...
 
class  InterfaceJoint
 Interface element representing a Joint. More...
 
class  InterfaceLink
 Interface element representing a Link. More...
 
class  InterfaceModel
 Interface element representing a Model. More...
 
class  InterfaceModelPoseGraph
 Class used in reposture callbacks of custom parsers to resolve poses. More...
 
class  InternalError
 Class for generating Internal Gazebo Errors: those errors which should never happend and represent programming bugs. More...
 
class  Joint
 
class  JointAxis
 Parameters related to the axis of rotation for rotational joints, and the axis of translation for prismatic joints. More...
 
class  Lidar
 Lidar contains information about a Lidar sensor. More...
 
class  Light
 Provides a description of a light source. More...
 
class  Link
 
class  Magnetometer
 Magnetometer contains information about a magnetometer sensor. More...
 
class  Material
 This class contains visual material properties. More...
 
class  Mesh
 Mesh represents a mesh shape, and is usually accessed through a Geometry. More...
 
class  MimicConstraint
 Helper class to hold contents of a joint axis mimic tag, which define a Mimic constraint. More...
 
class  Model
 
class  NavSat
 NavSat contains information about a NavSat sensor. More...
 
class  NestedInclude
 Contains the necessary information about an included model file for custom model parsers to be able to find the file and parse it. More...
 
class  Noise
 The Noise class contains information about a noise model, such as a Gaussian distribution. More...
 
class  ODE
 ODE information for a friction. More...
 
class  OutputConfig
 This class contains configuration options for SDF output. More...
 
class  Param
 A parameter class. More...
 
class  ParamPrivate
 
struct  ParamStreamer
 
class  ParserConfig
 This class contains configuration options for the libsdformat parser. More...
 
class  ParticleEmitter
 A description of a particle emitter, which can be attached to a link. More...
 
class  Pbr
 This class provides access to Physically-Based-Rendering (PBR) material workflows. More...
 
class  PbrWorkflow
 This class contains Physically-Based-Rendering (PBR) workflow properties. More...
 
class  Physics
 The physics element specifies the type and properties of a dynamics engine. More...
 
class  Plane
 Plane represents a plane shape, and is usually accessed through a Geometry. More...
 
class  Plugin
 
class  Polyline
 Polyline represents a 2D path. Multiple polylines can be combined. More...
 
class  PrintConfig
 This class contains configuration options for printing elements. More...
 
class  Projector
 A description of a projector, which can be attached to a link. More...
 
class  Root
 Root class that acts as an entry point to the SDF document model. More...
 
class  Scene
 
class  ScopedGraph
 
class  SDF
 Base SDF class. More...
 
class  SemanticPose
 SemanticPose is a data structure that can be used by different DOM objects to resolve poses on a PoseRelativeToGraph. More...
 
class  Sensor
 Information about an SDF sensor. More...
 
class  Sky
 
class  Sphere
 Sphere represents a sphere shape, and is usually accessed through a Geometry. More...
 
class  Surface
 Surface information for a collision. More...
 
class  Time
 A Time class, can be used to hold wall- or sim-time. More...
 
class  Torsional
 Torsional friction. More...
 
class  Trajectory
 Trajectory for Animation. More...
 
class  Visual
 
class  Waypoint
 Waypoint for Trajectory. More...
 
class  World
 

Typedefs

typedef std::shared_ptr< ConsoleConsolePtr
 
using CustomInertiaCalculator = std::function< std::optional< gz::math::Inertiald >(sdf::Errors &, const sdf::CustomInertiaCalcProperties &)>
 
using CustomModelParser = std::function< sdf::InterfaceModelPtr(const sdf::NestedInclude &, Errors &)>
 Defines a custom model parser. More...
 
typedef std::shared_ptr< const ElementElementConstPtr
 
using ElementPtr = std::shared_ptr< Element >
 
typedef std::vector< ElementPtrElementPtr_V
 
using ElementWeakPtr = std::weak_ptr< Element >
 
using Errors = std::vector< Error >
 A vector of Error. More...
 
using InterfaceModelConstPtr = std::shared_ptr< const InterfaceModel >
 
using InterfaceModelPtr = std::shared_ptr< InterfaceModel >
 
typedef std::vector< ParamPtrParam_V
 
typedef std::shared_ptr< ParamParamPtr
 
using Plugins = std::vector< Plugin >
 A vector of Plugin. More...
 
using RepostureFunction = std::function< void(const sdf::InterfaceModelPoseGraph &)>
 Function signature for the reposture callback function. More...
 
typedef std::shared_ptr< SDFSDFPtr
 

Enumerations

enum class  AtmosphereType { ADIABATIC = 0 }
 The set of atmosphere model types. More...
 
enum class  ConfigureResolveAutoInertials { SKIP_CALCULATION_IN_LOAD , SAVE_CALCULATION }
 Configuration options of how CalculateInertial() function would be used. More...
 
enum class  EnforcementPolicy { ERR , WARN , LOG }
 Policy to describe how to treat certain conditions when parsing. More...
 
enum class  ErrorCode {
  NONE = 0 , FILE_READ , DUPLICATE_NAME , RESERVED_NAME ,
  ATTRIBUTE_MISSING , ATTRIBUTE_INVALID , ATTRIBUTE_DEPRECATED , ATTRIBUTE_INCORRECT_TYPE ,
  ELEMENT_MISSING , ELEMENT_INVALID , ELEMENT_DEPRECATED , ELEMENT_INCORRECT_TYPE ,
  ELEMENT_ERROR , URI_INVALID , URI_LOOKUP , DIRECTORY_NONEXISTANT ,
  MODEL_CANONICAL_LINK_INVALID , MODEL_WITHOUT_LINK , NESTED_MODELS_UNSUPPORTED , LINK_INERTIA_INVALID ,
  JOINT_CHILD_LINK_INVALID , JOINT_PARENT_LINK_INVALID , JOINT_PARENT_SAME_AS_CHILD , FRAME_ATTACHED_TO_INVALID ,
  FRAME_ATTACHED_TO_CYCLE , FRAME_ATTACHED_TO_GRAPH_ERROR , POSE_RELATIVE_TO_INVALID , POSE_RELATIVE_TO_CYCLE ,
  POSE_RELATIVE_TO_GRAPH_ERROR , ROTATION_SNAP_CONFIG_ERROR , STRING_READ , MODEL_PLACEMENT_FRAME_INVALID ,
  VERSION_DEPRECATED , MERGE_INCLUDE_UNSUPPORTED , PARAMETER_ERROR , UNKNOWN_PARAMETER_TYPE ,
  FATAL_ERROR , WARNING , JOINT_AXIS_EXPRESSED_IN_INVALID , CONVERSION_ERROR ,
  PARSING_ERROR , JOINT_AXIS_MIMIC_INVALID , XML_ERROR
}
 Set of error codes. More...
 
enum class  ForceTorqueFrame : uint8_t { INVALID = 0 , PARENT = 1 , CHILD = 2 , SENSOR = 3 }
 The set of supported frames of the wrench values. More...
 
enum class  ForceTorqueMeasureDirection : uint8_t { INVALID = 0 , PARENT_TO_CHILD = 1 , CHILD_TO_PARENT = 2 }
 The set of measure directions of the wrench values. More...
 
enum class  GeometryType {
  EMPTY = 0 , BOX = 1 , CYLINDER = 2 , PLANE = 3 ,
  SPHERE = 4 , MESH = 5 , HEIGHTMAP = 6 , CAPSULE = 7 ,
  ELLIPSOID = 8 , POLYLINE = 9 , CONE = 10
}
 The set of geometry types. More...
 
enum class  JointType {
  INVALID = 0 , BALL = 1 , CONTINUOUS = 2 , FIXED = 3 ,
  GEARBOX = 4 , PRISMATIC = 5 , REVOLUTE = 6 , REVOLUTE2 = 7 ,
  SCREW = 8 , UNIVERSAL = 9
}
 The set of joint types. More...
 
enum class  LightType { INVALID = 0 , POINT = 1 , SPOT = 2 , DIRECTIONAL = 3 }
 The set of light types. More...
 
enum class  MeshOptimization { NONE , CONVEX_HULL , CONVEX_DECOMPOSITION }
 Mesh optimization method. More...
 
enum class  NoiseType { NONE = 0 , GAUSSIAN = 1 , GAUSSIAN_QUANTIZED = 2 }
 The set of noise types. More...
 
enum class  NormalMapSpace : int { TANGENT = 0 , OBJECT = 1 }
 Space the normal map is defined in. More...
 
enum class  ParticleEmitterType { POINT = 0 , BOX = 1 , CYLINDER = 2 , ELLIPSOID = 3 }
 The set of particle emitter types. More...
 
enum class  PbrWorkflowType : int { NONE = 0 , METAL = 1 , SPECULAR = 2 }
 Type of PBR workflow. More...
 
enum class  PixelFormatType {
  UNKNOWN_PIXEL_FORMAT = 0 , L_INT8 , L_INT16 , RGB_INT8 ,
  RGBA_INT8 , BGRA_INT8 , RGB_INT16 , RGB_INT32 ,
  BGR_INT8 , BGR_INT16 , BGR_INT32 , R_FLOAT16 ,
  RGB_FLOAT16 , R_FLOAT32 , RGB_FLOAT32 , BAYER_RGGB8 ,
  BAYER_BGGR8 , BAYER_GBRG8 , BAYER_GRBG8
}
 The set of pixel formats. More...
 
enum class  SensorType {
  NONE = 0 , ALTIMETER = 1 , CAMERA = 2 , CONTACT = 3 ,
  DEPTH_CAMERA = 4 , FORCE_TORQUE = 5 , GPS = 6 , GPU_LIDAR = 7 ,
  IMU = 8 , LOGICAL_CAMERA = 9 , MAGNETOMETER = 10 , MULTICAMERA = 11 ,
  LIDAR = 12 , RFID = 13 , RFIDTAG = 14 , SONAR = 15 ,
  WIRELESS_RECEIVER = 16 , WIRELESS_TRANSMITTER = 17 , AIR_PRESSURE = 18 , RGBD_CAMERA = 19 ,
  THERMAL_CAMERA = 20 , NAVSAT = 21 , SEGMENTATION_CAMERA = 22 , BOUNDINGBOX_CAMERA = 23 ,
  CUSTOM = 24 , WIDE_ANGLE_CAMERA = 25 , AIR_SPEED = 26
}
 The set of sensor types. More...
 
enum class  ShaderType : int { PIXEL = 0 , VERTEX = 1 , NORMAL_MAP_OBJECTSPACE = 2 , NORMAL_MAP_TANGENTSPACE = 3 }
 

Functions

GZ_SDFORMAT_VISIBLE void addURIPath (const std::string &_uri, const std::string &_path)
 Associate paths to a URI. More...
 
GZ_SDFORMAT_VISIBLE 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 if the attribute is set and not empty. More...
 
GZ_SDFORMAT_VISIBLE bool checkCanonicalLinkNames (sdf::Errors &_errors, const sdf::Root *_root)
 Check that for each model, the canonical_link attribute value matches the name of a link in the model if the attribute is set and not empty. More...
 
GZ_SDFORMAT_VISIBLE bool checkFrameAttachedToGraph (const sdf::Root *_root)
 For the world and each model, check that the attached_to graphs build without errors and have no cycles. More...
 
GZ_SDFORMAT_VISIBLE bool checkFrameAttachedToGraph (sdf::Errors &_errors, const sdf::Root *_root)
 For the world and each model, check that the attached_to graphs build without errors and have no cycles. More...
 
GZ_SDFORMAT_VISIBLE 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 match the name of a link, joint, or other frame in the model if the attribute is set and not empty. More...
 
GZ_SDFORMAT_VISIBLE bool checkFrameAttachedToNames (sdf::Errors &_errors, const sdf::Root *_root)
 Check that for each frame, the attached_to attribute value does not match its own frame name but does match the name of a link, joint, or other frame in the model if the attribute is set and not empty. More...
 
GZ_SDFORMAT_VISIBLE void checkJointAxisExpressedInValues (const sdf::Root *_root, Errors &_errors)
 Check that all joint axes in contained joints specify xyz expressed-in names that match the names of valid frames. More...
 
GZ_SDFORMAT_VISIBLE void checkJointAxisMimicValues (const sdf::Root *_root, Errors &_errors)
 Check that all joint axes in contained joints that specify mimic constraints use valid joint names. More...
 
GZ_SDFORMAT_VISIBLE bool checkJointParentChildNames (const sdf::Root *_root)
 Check that all joints in contained models specify parent and child link names that match the names of sibling links. More...
 
GZ_SDFORMAT_VISIBLE GZ_DEPRECATED(13) bool checkJointParentChildLinkNames(const sdf GZ_SDFORMAT_VISIBLE void checkJointParentChildNames (const sdf::Root *_root, Errors &_errors)
 Check that all joints in contained models specify parent and child link names that match the names of sibling links. More...
 
GZ_SDFORMAT_VISIBLE bool checkPoseRelativeToGraph (const sdf::Root *_root)
 For the world and each model, check that the attached_to graphs build without errors and have no cycles. More...
 
GZ_SDFORMAT_VISIBLE bool checkPoseRelativeToGraph (sdf::Errors &_errors, const sdf::Root *_root)
 For the world and each model, check that the attached_to graphs build without errors and have no cycles. More...
 
GZ_SDFORMAT_VISIBLE std::string computeMergedModelProxyFrameName (const std::string &_modelName)
 Function to compute a merged model's proxy frame name. More...
 
GZ_SDFORMAT_VISIBLE bool convertFile (const std::string &_filename, const std::string &_version, const ParserConfig &_config, SDFPtr _sdf)
 Convert an SDF file to a specific SDF version. More...
 
GZ_SDFORMAT_VISIBLE bool convertFile (const std::string &_filename, const std::string &_version, SDFPtr _sdf)
 Convert an SDF file to a specific SDF version. More...
 
GZ_SDFORMAT_VISIBLE sdf::Errors convertFile (SDFPtr _sdf, const std::string &_filename, const std::string &_version, const ParserConfig &_config=ParserConfig::GlobalConfig())
 Convert an SDF file to a specific SDF version. More...
 
GZ_SDFORMAT_VISIBLE bool convertString (const std::string &_sdfString, const std::string &_version, const ParserConfig &_config, SDFPtr _sdf)
 Convert an SDF string to a specific SDF version. More...
 
GZ_SDFORMAT_VISIBLE bool convertString (const std::string &_sdfString, const std::string &_version, SDFPtr _sdf)
 Convert an SDF string to a specific SDF version. More...
 
GZ_SDFORMAT_VISIBLE sdf::Errors convertString (SDFPtr _sdf, const std::string &_sdfString, const std::string &_version, const ParserConfig &_config=ParserConfig::GlobalConfig())
 Convert an SDF string to a specific SDF version. More...
 
template<typename T >
bool equal (const T &_a, const T &_b, const T &_epsilon=1e-6f)
 check if two values are equal, within a tolerance More...
 
GZ_SDFORMAT_VISIBLE std::string findFile (const std::string &_filename, bool _searchLocalPath, bool _useCallback, const ParserConfig &_config)
 Find the absolute path of a file. More...
 
GZ_SDFORMAT_VISIBLE std::string findFile (const std::string &_filename, bool _searchLocalPath=true, bool _useCallback=false)
 Find the absolute path of a file. More...
 
GZ_SDFORMAT_VISIBLE std::string findFile (sdf::Errors &_errors, const std::string &_filename, bool _searchLocalPath, bool _useCallback, const ParserConfig &_config)
 Find the absolute path of a file. More...
 
GZ_SDFORMAT_VISIBLE std::string findFile (sdf::Errors &_errors, const std::string &_filename, bool _searchLocalPath=true, bool _useCallback=false)
 Find the absolute path of a file. More...
 
GZ_SDFORMAT_VISIBLE std::string getInstallPrefix ()
 getInstallPrefix return the install prefix of the library i.e. More...
 
GZ_SDFORMAT_VISIBLE std::string getModelFilePath (const std::string &_modelDirPath)
 Get the file path to the model file. More...
 
GZ_SDFORMAT_VISIBLE std::string getModelFilePath (sdf::Errors &_errors, const std::string &_modelDirPath)
 Get the file path to the model file. More...
 
GZ_SDFORMAT_VISIBLE std::string getSharePath ()
 getSharePath return the share directory used by sdformat More...
 
class GZ_SDFORMAT_VISIBLE GZ_DEPRECATED (13) Inertia
 A class for inertial information about a link. More...
 
GZ_SDFORMAT_VISIBLE bool init (sdf::Errors &_errors, SDFPtr _sdf, const ParserConfig &_config)
 Initialize the SDF interface from the embedded root spec file. More...
 
GZ_SDFORMAT_VISIBLE bool init (SDFPtr _sdf)
 Initialize the SDF interface from the embedded root spec file. More...
 
GZ_SDFORMAT_VISIBLE bool init (SDFPtr _sdf, const ParserConfig &_config)
 Initialize the SDF interface from the embedded root spec file. More...
 
GZ_SDFORMAT_VISIBLE bool initFile (const std::string &_filename, const ParserConfig &_config, ElementPtr _sdf)
 Initialize an SDFElement interface using a file. More...
 
GZ_SDFORMAT_VISIBLE bool initFile (const std::string &_filename, const ParserConfig &_config, ElementPtr _sdf, sdf::Errors &_errors)
 Initialize an SDFElement interface using a file. More...
 
GZ_SDFORMAT_VISIBLE bool initFile (const std::string &_filename, const ParserConfig &_config, SDFPtr _sdf)
 Initialize the SDF interface using a file. More...
 
GZ_SDFORMAT_VISIBLE bool initFile (const std::string &_filename, const ParserConfig &_config, SDFPtr _sdf, sdf::Errors &_errors)
 Initialize the SDF interface using a file. More...
 
GZ_SDFORMAT_VISIBLE bool initFile (const std::string &_filename, ElementPtr _sdf)
 Initialize an SDF Element interface using a file. More...
 
GZ_SDFORMAT_VISIBLE bool initFile (const std::string &_filename, SDFPtr _sdf)
 Initialize the SDF interface using a file. More...
 
GZ_SDFORMAT_VISIBLE bool initString (const std::string &_xmlString, const ParserConfig &_config, SDFPtr _sdf)
 Initialize the SDF interface using a string. More...
 
GZ_SDFORMAT_VISIBLE bool initString (const std::string &_xmlString, const ParserConfig &_config, SDFPtr _sdf, sdf::Errors &_errors)
 Initialize the SDF interface using a string. More...
 
GZ_SDFORMAT_VISIBLE bool initString (const std::string &_xmlString, SDFPtr _sdf)
 Initialize the SDF interface using a string. More...
 
GZ_SDFORMAT_VISIBLE std::string JoinName (const std::string &_scopeName, const std::string &_localName)
 Join two strings with the '::' delimiter. More...
 
std::string GZ_SDFORMAT_VISIBLE lowercase (const std::string &_in)
 Transforms a string to its lowercase equivalent. More...
 
GZ_SDFORMAT_VISIBLE std::ostream & operator<< (std::ostream &_out, const sdf::Errors &_errs)
 Output operator for a collection of errors. More...
 
template<class... Ts>
std::ostream & operator<< (std::ostream &os, ParamStreamer< std::variant< Ts... >> sv)
 
template<class T >
std::ostream & operator<< (std::ostream &os, ParamStreamer< T > s)
 
template<typename ParamVariant >
 ParamStreamer (const ParamVariant &_val, int _precision) -> ParamStreamer< ParamVariant >
 
GZ_SDFORMAT_VISIBLE sdf::SDFPtr readFile (const std::string &_filename)
 Populate the SDF values from a file. More...
 
GZ_SDFORMAT_VISIBLE sdf::SDFPtr readFile (const std::string &_filename, const ParserConfig &_config, Errors &_errors)
 Populate the SDF values from a file. More...
 
GZ_SDFORMAT_VISIBLE bool readFile (const std::string &_filename, const ParserConfig &_config, SDFPtr _sdf, Errors &_errors)
 Populate the SDF values from a file. More...
 
GZ_SDFORMAT_VISIBLE sdf::SDFPtr readFile (const std::string &_filename, Errors &_errors)
 Populate the SDF values from a file. More...
 
GZ_SDFORMAT_VISIBLE bool readFile (const std::string &_filename, SDFPtr _sdf)
 Populate the SDF values from a file. More...
 
GZ_SDFORMAT_VISIBLE bool readFile (const std::string &_filename, SDFPtr _sdf, Errors &_errors)
 Populate the SDF values from a file. More...
 
GZ_SDFORMAT_VISIBLE bool readFileWithoutConversion (const std::string &_filename, const ParserConfig &_config, SDFPtr _sdf, Errors &_errors)
 Populate the SDF values from a file without converting to the latest SDF version. More...
 
GZ_SDFORMAT_VISIBLE bool readFileWithoutConversion (const std::string &_filename, SDFPtr _sdf, Errors &_errors)
 Populate the SDF values from a file without converting to the latest SDF version. More...
 
GZ_SDFORMAT_VISIBLE bool readString (const std::string &_xmlString, const ParserConfig &_config, ElementPtr _sdf, Errors &_errors)
 Populate the SDF values from a string. More...
 
GZ_SDFORMAT_VISIBLE bool readString (const std::string &_xmlString, const ParserConfig &_config, SDFPtr _sdf, Errors &_errors)
 Populate the SDF values from a string. More...
 
GZ_SDFORMAT_VISIBLE bool readString (const std::string &_xmlString, ElementPtr _sdf)
 Populate the SDF values from a string. More...
 
GZ_SDFORMAT_VISIBLE bool readString (const std::string &_xmlString, ElementPtr _sdf, Errors &_errors)
 Populate the SDF values from a string. More...
 
GZ_SDFORMAT_VISIBLE bool readString (const std::string &_xmlString, SDFPtr _sdf)
 Populate the SDF values from a string. More...
 
GZ_SDFORMAT_VISIBLE bool readString (const std::string &_xmlString, SDFPtr _sdf, Errors &_errors)
 Populate the SDF values from a string. More...
 
GZ_SDFORMAT_VISIBLE bool readStringWithoutConversion (const std::string &_xmlString, const ParserConfig &_config, SDFPtr _sdf, Errors &_errors)
 Populate the SDF values from a string. More...
 
GZ_SDFORMAT_VISIBLE bool readStringWithoutConversion (const std::string &_xmlString, SDFPtr _sdf, Errors &_errors)
 Populate the SDF values from a string without converting to the latest SDF version. More...
 
GZ_SDFORMAT_VISIBLE bool recursiveSameTypeUniqueNames (sdf::ElementPtr _elem)
 Check that all sibling elements of the same type have unique names. More...
 
GZ_SDFORMAT_VISIBLE bool recursiveSameTypeUniqueNames (sdf::Errors &_errors, sdf::ElementPtr _elem)
 Check that all sibling elements of the same type have unique names. More...
 
GZ_SDFORMAT_VISIBLE bool recursiveSiblingNoDoubleColonInNames (sdf::ElementPtr _elem)
 Check that all sibling elements do not contain the delimiter double colons '::' in element names, which is reserved for forming scopes in SDFormat 1.8. More...
 
GZ_SDFORMAT_VISIBLE bool recursiveSiblingNoDoubleColonInNames (sdf::Errors &_errors, sdf::ElementPtr _elem)
 Check that all sibling elements do not contain the delimiter double colons '::' in element names, which is reserved for forming scopes in SDFormat 1.8. More...
 
GZ_SDFORMAT_VISIBLE bool recursiveSiblingUniqueNames (sdf::ElementPtr _elem)
 Check that all sibling elements of the any type have unique names. More...
 
GZ_SDFORMAT_VISIBLE bool recursiveSiblingUniqueNames (sdf::Errors &_errors, sdf::ElementPtr _elem)
 Check that all sibling elements of the any type have unique names. More...
 
GZ_SDFORMAT_VISIBLE void setFindCallback (std::function< std::string(const std::string &)> _cb)
 Set the callback to use when SDF can't find a file. More...
 
GZ_SDFORMAT_VISIBLE bool shouldValidateElement (sdf::ElementPtr _elem)
 Check whether the element should be validated. More...
 
GZ_SDFORMAT_VISIBLE std::vector< std::string > split (const std::string &_str, const std::string &_splitter)
 Split a string using the delimiter in splitter. More...
 
GZ_SDFORMAT_VISIBLE std::pair< std::string, std::string > SplitName (const std::string &_absoluteName)
 Split a name into a two strings based on the '::' delimeter. More...
 
GZ_SDFORMAT_VISIBLE std::string trim (const char *_in)
 Trim leading and trailing whitespace from a string. More...
 
GZ_SDFORMAT_VISIBLE std::string trim (const std::string &_in)
 Trim leading and trailing whitespace from a string. More...
 

Variables

class GZ_SDFORMAT_VISIBLE Element
 
constexpr std::string_view kScopeDelimiter {"::"}
 
constexpr GZ_DEPRECATED(14) inline const std char kSdfStringSource [] = "<data-string>"
 The source path replacement if it was parsed from a string, instead of a file. More...
 
constexpr char kUrdfStringSource [] = "<urdf-string>"
 The source path replacement if the urdf was parsed from a string, instead of a file. More...
 
class GZ_SDFORMAT_VISIBLE Param
 
class GZ_SDFORMAT_VISIBLE SDF
 

Detailed Description

namespace for Simulation Description Format parser

The parsing functions read XML elements contained in either a file or string and translates the XML elements into SDF data structures. This translation finds errors in the provided XML, fills in default values, and performs any necessary version related conversions.

XML elements that are not part of the SDF specification are copied in place. This preserves the given XML structure and data.