17 #ifndef SDF_INTERFACE_ELEMENTS_HH_
18 #define SDF_INTERFACE_ELEMENTS_HH_
23 #include <gz/math/Pose3.hh>
24 #include <gz/utils/ImplPtr.hh>
25 #include <gz/utils/SuppressWarning.hh>
36 inline namespace SDF_VERSION_NAMESPACE
41 #pragma warning(disable: 4251)
54 public:
const std::string &
Uri()
const;
58 public:
void SetUri(
const std::string &_uri);
100 public:
const std::optional<bool> &
IsStatic()
const;
125 const std::string &_includePoseRelativeTo);
155 public:
const std::optional<bool> &
IsMerge()
const;
158 GZ_UTILS_IMPL_PTR(dataPtr)
Contains the necessary information about an included model file for custom model parsers to be able t...
Definition: InterfaceElements.hh:46
const std::optional< std::string > & LocalModelName() const
Name relative to immediate parent as specified in //include/name.
void SetPlacementFrame(const std::string &_placementFrame)
Set the placement frame.
void SetUri(const std::string &_uri)
Set the URI of the included model.
const std::optional< std::string > & PlacementFrame() const
The placement frame as specified in //include/placement_frame.
const std::string & ResolvedFileName() const
Provides the resolved absolute file path from the URI.
NestedInclude()
Constructor.
void SetAbsoluteParentName(const std::string &_absoluteparentname)
Set the absolute name of parent entity.
const std::optional< std::string > & IncludePoseRelativeTo() const
The relative-to frame of the pose as specified in //include/pose/@relative_to.
void SetIncludePoseRelativeTo(const std::string &_includePoseRelativeTo)
Set the relative-to frame of the pose.
void SetIncludeElement(sdf::ElementPtr _includeElement)
Set the //include element.
void SetIncludeRawPose(const gz::math::Pose3d &_includeRawPose)
Set the raw pose as specified in //include/pose.
void SetResolvedFileName(const std::string &_resolvedFileName)
Set the resolved absolute file path.
void SetIsMerge(bool _isMerge)
Set whether the interface model is to be merge-included (i.e set the value of //include/[@merge])
void SetIsStatic(bool _isStatic)
Set whether the model is static.
const std::string & AbsoluteParentName() const
Name of the parent entity in absolute hierarchy.
sdf::ElementPtr IncludeElement() const
This is the //include element.
const std::optional< gz::math::Pose3d > & IncludeRawPose() const
The raw pose as specified in //include/pose.
const std::optional< bool > & IsStatic() const
Whether the model is static as defined by //include/static.
const std::string & Uri() const
Provides the URI as specified in //include/uri.
void SetLocalModelName(const std::string &_localModelName)
Set the name relative to immediate parent as specified in //include/name
const std::optional< bool > & IsMerge() const
Whether the interface model is to be merge-included.
std::function< sdf::InterfaceModelPtr(const sdf::NestedInclude &, Errors &)> CustomModelParser
Defines a custom model parser.
Definition: InterfaceElements.hh:198
std::shared_ptr< InterfaceModel > InterfaceModelPtr
Definition: InterfaceModel.hh:49
std::vector< Error > Errors
A vector of Error.
Definition: Types.hh:95
std::shared_ptr< Element > ElementPtr
Definition: Element.hh:55
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