sdf::v11::NestedInclude Struct Reference

Contains the necessary information about an included model file for custom model parsers to be able to find the file and parse it. More...

#include <InterfaceElements.hh>

## Public Attributes

std::string absoluteParentName
Name of the parent entity in absolute hierarchy. More...

sdf::ElementPtr includeElement
This is the //include element. More...

std::optional< std::string > includePoseRelativeTo
The relative-to frame of the pose as specified in //include/pose/@relative_to. More...

std::optional< ignition::math::Pose3d > includeRawPose
The raw pose as specified in //include/pose. More...

std::optional< bool > isStatic
Whether the model is static as defined by //include/static. More...

std::optional< std::string > localModelName
Name relative to immediate parent as specified in //include/name. More...

std::optional< std::string > placementFrame
The placement frame as specified in //include/placement_frame. More...

std::string resolvedFileName
Provides the resolved absolute file path from the URI. More...

std::string uri
Provides the URI as specified in //include/uri. More...

## Detailed Description

Contains the necessary information about an included model file for custom model parsers to be able to find the file and parse it.

## ◆ absoluteParentName

 std::string sdf::v11::NestedInclude::absoluteParentName

Name of the parent entity in absolute hierarchy.

Example: if the interface model's name is top_model::middle_model::my_new_model, the absoluteParentName would be top_model::middle_model. If the parent entity is the world, this would be an empty string.

## ◆ includeElement

 sdf::ElementPtr sdf::v11::NestedInclude::includeElement

This is the //include element.

This can be used to pass custom elements and attributes to the custom model parser.

## ◆ includePoseRelativeTo

 std::optional sdf::v11::NestedInclude::includePoseRelativeTo

The relative-to frame of the pose as specified in //include/pose/@relative_to.

This is nullopt if //include/pose/@relative_to is not set.

## ◆ includeRawPose

 std::optional sdf::v11::NestedInclude::includeRawPose

The raw pose as specified in //include/pose.

This is nullopt if //include/pose is not set.

## ◆ isStatic

 std::optional sdf::v11::NestedInclude::isStatic

Whether the model is static as defined by //include/static.

This is nullopt if //include/static is not set.

## ◆ localModelName

 std::optional sdf::v11::NestedInclude::localModelName

Name relative to immediate parent as specified in //include/name.

This is nullopt if //include/name is not set. Then the name of the model must be determined by the custom model parser from the included model file. Example: my_new_model

## ◆ placementFrame

 std::optional sdf::v11::NestedInclude::placementFrame

The placement frame as specified in //include/placement_frame.

This is nullopt if //include/placement_frame is is not set.

## ◆ resolvedFileName

 std::string sdf::v11::NestedInclude::resolvedFileName

Provides the resolved absolute file path from the URI.

It is recommended to use this in CustomModelParser when checking predicates on filenames – however, the predicates should generally only check the file extension.

## ◆ uri

 std::string sdf::v11::NestedInclude::uri

Provides the URI as specified in //include/uri.

This may or may not end with a file extension (it will not end with an extension if it refers to a model package).

The documentation for this struct was generated from the following file: