Auterion App SDK
Auterion SDK is a library that can be used by AuterionOS apps to communicate with the system.
auterion::GlobalPositionAssessor Class Reference

Class for assessing various properties of LocalPosition objects. More...

#include <auterion_sdk/system_state/global_position_assessor.hpp>

Public Member Functions

 GlobalPositionAssessor (const SystemState &system_state, const GlobalPositionAssessorConfig &config=GlobalPositionAssessorConfig{})
 Constructor for GlobalPositionAssessor. More...
 
 ~GlobalPositionAssessor ()=default
 Destructor for GlobalPositionAssessor.
 
bool isPositionWithinThreshold (const Eigen::Vector3d &target_position, const std::optional< float > position_error_threshold_m=std::nullopt) const
 Check if the current position is within specified thresholds of the target location. More...
 

Detailed Description

Class for assessing various properties of LocalPosition objects.

See also
auterion::LocalPosition

Constructor & Destructor Documentation

◆ GlobalPositionAssessor()

auterion::GlobalPositionAssessor::GlobalPositionAssessor ( const SystemState system_state,
const GlobalPositionAssessorConfig config = GlobalPositionAssessorConfig{} 
)
explicit

Constructor for GlobalPositionAssessor.

Parameters
system_stateReference to the SystemState instance.
configConfiguration for the GlobalPositionAssessor, defines default acceptance criteria (optional).

Member Function Documentation

◆ isPositionWithinThreshold()

bool auterion::GlobalPositionAssessor::isPositionWithinThreshold ( const Eigen::Vector3d &  target_position,
const std::optional< float >  position_error_threshold_m = std::nullopt 
) const

Check if the current position is within specified thresholds of the target location.

Parameters
target_positionTarget global position.
position_error_threshold_mPosition error threshold [m] (optional).
Returns
True if the position is within threshold, false otherwise.

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