Loading...
Searching...
No Matches
sdf::SDF_VERSION_NAMESPACE::Waypoint Class Reference

Waypoint for Trajectory. More...

#include <Actor.hh>

Public Member Functions

 Waypoint ()
 Default constructor.
Errors Load (ElementPtr _sdf)
 Load the waypoint based on a element pointer.
gz::math::Pose3d Pose () const
 Get the pose to be reached.
void SetPose (const gz::math::Pose3d &_pose)
 Set the pose to be reached.
void SetTime (double _time)
 Set the time in seconds when the pose should be reached.
double Time () const
 Get the time in seconds when the pose should be reached.

Detailed Description

Constructor & Destructor Documentation

◆ Waypoint()

sdf::SDF_VERSION_NAMESPACE::Waypoint::Waypoint ( )

Default constructor.

Member Function Documentation

◆ Load()

Errors sdf::SDF_VERSION_NAMESPACE::Waypoint::Load ( ElementPtr _sdf)

Load the waypoint based on a element pointer.

This is not the usual entry point. Typical usage of the SDF DOM is through the Root object.

Parameters
[in]_sdfThe SDF Element pointer
Returns
Errors, which is a vector of Error objects. Each Error includes an error code and message. An empty vector indicates no error.

◆ Pose()

gz::math::Pose3d sdf::SDF_VERSION_NAMESPACE::Waypoint::Pose ( ) const

Get the pose to be reached.

Returns
Pose to be reached.

◆ SetPose()

void sdf::SDF_VERSION_NAMESPACE::Waypoint::SetPose ( const gz::math::Pose3d & _pose)

Set the pose to be reached.

Parameters
[in]_posePose to be reached.

◆ SetTime()

void sdf::SDF_VERSION_NAMESPACE::Waypoint::SetTime ( double _time)

Set the time in seconds when the pose should be reached.

Parameters
[in]_timeTime in seconds for the pose to be reached.

◆ Time()

double sdf::SDF_VERSION_NAMESPACE::Waypoint::Time ( ) const

Get the time in seconds when the pose should be reached.

Returns
Time in seconds.

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