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

Waypoint for Trajectory. More...

#include <Actor.hh>

Public Member Functions

 Waypoint ()
 Default constructor. More...
 
 Waypoint (const Waypoint &_waypoint)
 Copy constructor. More...
 
 Waypoint (Waypoint &&_waypoint) noexcept
 Move constructor. More...
 
 ~Waypoint ()
 Destructor. More...
 
void CopyFrom (const Waypoint &_waypoint)
 Copy waypoint from an Waypoint instance. More...
 
Errors Load (ElementPtr _sdf)
 Load the waypoint based on a element pointer. More...
 
Waypointoperator= (const Waypoint &_waypoint)
 Assignment operator. More...
 
Waypointoperator= (Waypoint &&_waypoint)
 Move assignment operator. More...
 
gz::math::Pose3d Pose () const
 Get the pose to be reached. More...
 
void SetPose (const gz::math::Pose3d &_pose)
 Set the pose to be reached. More...
 
void SetTime (double _time)
 Set the time in seconds when the pose should be reached. More...
 
double Time () const
 Get the time in seconds when the pose should be reached. More...
 

Detailed Description

Waypoint for Trajectory.

Constructor & Destructor Documentation

◆ Waypoint() [1/3]

sdf::v9::Waypoint::Waypoint ( )

Default constructor.

◆ Waypoint() [2/3]

sdf::v9::Waypoint::Waypoint ( const Waypoint _waypoint)

Copy constructor.

Parameters
[in]_waypointWaypoint to copy.

◆ Waypoint() [3/3]

sdf::v9::Waypoint::Waypoint ( Waypoint &&  _waypoint)
noexcept

Move constructor.

Parameters
[in]_waypointWaypoint to move.

◆ ~Waypoint()

sdf::v9::Waypoint::~Waypoint ( )

Destructor.

Member Function Documentation

◆ CopyFrom()

void sdf::v9::Waypoint::CopyFrom ( const Waypoint _waypoint)

Copy waypoint from an Waypoint instance.

Parameters
[in]_waypointThe waypoint to set values from.

◆ Load()

Errors sdf::v9::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.

◆ operator=() [1/2]

Waypoint& sdf::v9::Waypoint::operator= ( const Waypoint _waypoint)

Assignment operator.

Parameters
[in]_waypointThe waypoint to set values from.
Returns
*this

◆ operator=() [2/2]

Waypoint& sdf::v9::Waypoint::operator= ( Waypoint &&  _waypoint)

Move assignment operator.

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

◆ Pose()

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

Get the pose to be reached.

Returns
Pose to be reached.

◆ SetPose()

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

Set the pose to be reached.

Parameters
[in]_posePose to be reached.

◆ SetTime()

void sdf::v9::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::v9::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: