geoops::RoverPose Struct Reference

This struct is used by the WaypointHandler to provide an easy way to store all pose data about the rover. More...

#include <GeospatialOperations.hpp>

Collaboration diagram for geoops::RoverPose:

Public Member Functions
	RoverPose (const geoops::GPSCoordinate &stRoverPosition=geoops::GPSCoordinate(), const double dRoverHeading=0.0)
	Construct a new Rover Pose object.
	RoverPose (const geoops::UTMCoordinate &stRoverPosition, const double dRoverHeading=0.0)
	Construct a new Rover Pose object.
const geoops::GPSCoordinate &	GetGPSCoordinate () const
	Accessor for the geoops::GPSCoordinate member variable.
const geoops::UTMCoordinate &	GetUTMCoordinate () const
	Accessor for the geoops::UTMCoordinate member variable.
double	GetCompassHeading () const
	Accessor for the Compass Heading private member.
bool	operator== (const RoverPose &stOtherRoverPose) const
	Overridden operator equals for RoverPose struct.
bool	operator!= (const RoverPose &stOtherRoverPose) const
	Overridden operator equals for RoverPose struct.

Private Attributes
Waypoint	stRoverPosition
double	dRoverHeading

Detailed Description

This struct is used by the WaypointHandler to provide an easy way to store all pose data about the rover.

Author

clayjay3 (clayt.nosp@m.onra.nosp@m.ycowe.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om)

Date

2024-04-08

Constructor & Destructor Documentation

RoverPose() [1/2]

geoops::RoverPose::RoverPose ( const geoops::GPSCoordinate &  stRoverPosition = geoops::GPSCoordinate(), const double  dRoverHeading = 0.0  )

inline

Construct a new Rover Pose object.

Parameters

stRoverPosition	- The current location of the rover stored in a GPSCoordinate struct.
dRoverHeading	- The current heading of the rover.

Author

clayjay3 (clayt.nosp@m.onra.nosp@m.ycowe.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om)

Date

2024-04-08

            {
                // Update member variables.
                this->stRoverPosition = Waypoint(stRoverPosition);
                this->dRoverHeading   = dRoverHeading;
            }

RoverPose() [2/2]

geoops::RoverPose::RoverPose ( const geoops::UTMCoordinate &  stRoverPosition, const double  dRoverHeading = 0.0  )

inline

Construct a new Rover Pose object.

Parameters

stRoverPosition	- The current location of the rover stored in a UTMCoordinate struct.
dRoverHeading	- The current heading of the rover.

Author

clayjay3 (clayt.nosp@m.onra.nosp@m.ycowe.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om)

Date

2024-04-08

            {
                // Update member variables.
                this->stRoverPosition = Waypoint(stRoverPosition);
                this->dRoverHeading   = dRoverHeading;
            }

Member Function Documentation

GetGPSCoordinate()

const geoops::GPSCoordinate & geoops::RoverPose::GetGPSCoordinate ( ) const

inline

Accessor for the geoops::GPSCoordinate member variable.

Returns

geoops::GPSCoordinate - The location of the RoverPose stored in a geoops namespace GPSCoordinate struct.

Author

clayjay3 (clayt.nosp@m.onra.nosp@m.ycowe.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om)

Date

2024-04-08

{ return stRoverPosition.GetGPSCoordinate(); }

Here is the call graph for this function:

Here is the caller graph for this function:

GetUTMCoordinate()

const geoops::UTMCoordinate & geoops::RoverPose::GetUTMCoordinate ( ) const

inline

Accessor for the geoops::UTMCoordinate member variable.

Returns

geoops::UTMCoordinate - The location of the RoverPose stored in a geoops namespace UTMCoordinate struct.

Author

clayjay3 (clayt.nosp@m.onra.nosp@m.ycowe.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om)

Date

2024-04-08

{ return stRoverPosition.GetUTMCoordinate(); }

Here is the call graph for this function:

Here is the caller graph for this function:

GetCompassHeading()

double geoops::RoverPose::GetCompassHeading ( ) const

inline

Accessor for the Compass Heading private member.

Returns

const double - The compass heading of the rover pose.

Author

clayjay3 (clayt.nosp@m.onra.nosp@m.ycowe.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om)

Date

2024-04-08

{ return dRoverHeading; }

Here is the caller graph for this function:

operator==()

bool geoops::RoverPose::operator== ( const RoverPose &  stOtherRoverPose ) const

inline

Overridden operator equals for RoverPose struct.

Parameters

stOtherRoverPose

- The other Waypoint struct we are comparing to.

Returns

true - The two RoverPoses are equal.

false - The two RoverPoses are not equal.

Author

clayjay3 (clayt.nosp@m.onra.nosp@m.ycowe.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om)

Date

2024-04-08

            {
                // Check if location, altitude, and accuracy are the same. Not going to worry about other values for now.
                return (stRoverPosition == stOtherRoverPose.GetGPSCoordinate() && stRoverPosition == stOtherRoverPose.GetUTMCoordinate() &&
                        dRoverHeading == stOtherRoverPose.dRoverHeading);
            }

Here is the call graph for this function:

Here is the caller graph for this function:

operator!=()

bool geoops::RoverPose::operator!= ( const RoverPose &  stOtherRoverPose ) const

inline

Overridden operator equals for RoverPose struct.

Parameters

stOtherRoverPose

- The other RoverPose struct we are comparing to.

Returns

true - The two RoverPoses are equal.

false - The two RoverPoses are not equal.

Author

clayjay3 (clayt.nosp@m.onra.nosp@m.ycowe.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om)

Date

2024-04-08

{ return !this->operator==(stOtherRoverPose); }

Here is the call graph for this function:

---

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

• src/util/GeospatialOperations.hpp