Public Member Functions | List of all members
sdf::v9::SemanticPose Class Reference

SemanticPose is a data structure that can be used by different DOM objects to resolve poses on a PoseRelativeToGraph. More...

#include <SemanticPose.hh>

Public Member Functions

 SemanticPose (const SemanticPose &_semanticPose)
 Copy constructor. More...
 
 SemanticPose (SemanticPose &&_semanticPose) noexcept
 Move constructor. More...
 
 ~SemanticPose ()
 Destructor. More...
 
SemanticPoseoperator= (SemanticPose &&_semanticPose)
 Move assignment operator. More...
 
SemanticPoseoperator= (const SemanticPose &_semanticPose)
 Copy assignment operator. More...
 
const ignition::math::Pose3d & RawPose () const
 Get the raw Pose3 transform. More...
 
const std::string & RelativeTo () const
 Get the name of the coordinate frame relative to which this object's pose is expressed. More...
 
Errors Resolve (ignition::math::Pose3d &_pose, const std::string &_resolveTo="") const
 Resolve pose of this object with respect to another named frame. More...
 

Detailed Description

SemanticPose is a data structure that can be used by different DOM objects to resolve poses on a PoseRelativeToGraph.

This object holds a Pose3 object, the name of the frame relative to which it is defined, a pointer to a PoseRelativeToGraph, and a default frame to resolve to. The name of the default frame to resolve to must not be empty. This class only has a private constructor, and may only be accessed from its friend DOM classes.

Constructor & Destructor Documentation

◆ ~SemanticPose()

sdf::v9::SemanticPose::~SemanticPose ( )

Destructor.

◆ SemanticPose() [1/2]

sdf::v9::SemanticPose::SemanticPose ( const SemanticPose _semanticPose)

Copy constructor.

Parameters
[in]_semanticposeSemanticPose to copy.

◆ SemanticPose() [2/2]

sdf::v9::SemanticPose::SemanticPose ( SemanticPose &&  _semanticPose)
noexcept

Move constructor.

Parameters
[in]_semanticposeSemanticPose to move.

Member Function Documentation

◆ operator=() [1/2]

SemanticPose& sdf::v9::SemanticPose::operator= ( SemanticPose &&  _semanticPose)

Move assignment operator.

Parameters
[in]_semanticposeSemanticPose to move.
Returns
Reference to this.

◆ operator=() [2/2]

SemanticPose& sdf::v9::SemanticPose::operator= ( const SemanticPose _semanticPose)

Copy assignment operator.

Parameters
[in]_semanticposeSemanticPose to copy.
Returns
Reference to this.

◆ RawPose()

const ignition::math::Pose3d& sdf::v9::SemanticPose::RawPose ( ) const

Get the raw Pose3 transform.

Returns
The raw Pose3 transform.

◆ RelativeTo()

const std::string& sdf::v9::SemanticPose::RelativeTo ( ) const

Get the name of the coordinate frame relative to which this object's pose is expressed.

An empty value indicates that the frame is relative to the default parent object.

Returns
The name of the pose relative-to frame.

◆ Resolve()

Errors sdf::v9::SemanticPose::Resolve ( ignition::math::Pose3d &  _pose,
const std::string &  _resolveTo = "" 
) const

Resolve pose of this object with respect to another named frame.

If there are any errors resolving the pose, the output will not be modified.

Parameters
[out]_poseThe resolved pose.
[in]_resolveToThe pose will be resolved with respect to this frame. If unset or empty, the default resolve-to frame will be used.
Returns
Errors in resolving pose.

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