Public Member Functions | List of all members
sdf::v11::InterfaceFrame Class Reference

Interface element representing an explicit frame. More...

#include <InterfaceFrame.hh>

Public Member Functions

 InterfaceFrame (const std::string &_name, const std::string &_attachedTo, const ignition::math::Pose3d &_pose)
 Constructor. More...
 
const std::string & AttachedTo () const
 Get the name of the coordinate frame to which this frame is attached. More...
 
const std::string & Name () const
 Get the name of the frame. More...
 
const ignition::math::Pose3d & PoseInAttachedToFrame () const
 Get the pose of this frame relative to the attached-to frame. More...
 

Detailed Description

Interface element representing an explicit frame.

Constructor & Destructor Documentation

◆ InterfaceFrame()

sdf::v11::InterfaceFrame::InterfaceFrame ( const std::string &  _name,
const std::string &  _attachedTo,
const ignition::math::Pose3d &  _pose 
)

Constructor.

Parameters
[in]_nameThe local name.
[in]_attachedToName of the attached-to frame. This cannot be an empty string. If the frame is attached to the model frame, this must be "__model__" . The (implicit or explicit) frame must exist in the scope of this frame.
[in]_poseThe pose of the frame relative to the attached-to frame.

Member Function Documentation

◆ AttachedTo()

const std::string& sdf::v11::InterfaceFrame::AttachedTo ( ) const

Get the name of the coordinate frame to which this frame is attached.

Returns
The name of the attached-to frame.

◆ Name()

const std::string& sdf::v11::InterfaceFrame::Name ( ) const

Get the name of the frame.

Returns
Local name of the frame.

◆ PoseInAttachedToFrame()

const ignition::math::Pose3d& sdf::v11::InterfaceFrame::PoseInAttachedToFrame ( ) const

Get the pose of this frame relative to the attached-to frame.

Returns
The pose of this frame in the attached-to frame.

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