ASCO Aerial Autonomy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
PositionControlTransitionGuardFunctor_< LogicStateMachineT > Struct Template Reference

Guard function to check the goal is within tolerance before starting towards goal. More...

#include <position_control_functors.h>

Inheritance diagram for PositionControlTransitionGuardFunctor_< LogicStateMachineT >:
Inheritance graph
[legend]
Collaboration diagram for PositionControlTransitionGuardFunctor_< LogicStateMachineT >:
Collaboration graph
[legend]

Public Member Functions

bool guard (const PositionYaw &goal, UAVSystem &robot_system)
 Override this guard function for different sub classes. This function decides whether to call the run function for each state. More...
 
- Public Member Functions inherited from GuardFunctor< PositionYaw, UAVSystem, LogicStateMachineT >
bool operator() (PositionYawconst &event, FSM &logic_state_machine, SourceState &, TargetState &)
 operator () Internally calls guard function More...
 
virtual ~GuardFunctor ()
 Destructor. More...
 

Detailed Description

template<class LogicStateMachineT>
struct PositionControlTransitionGuardFunctor_< LogicStateMachineT >

Guard function to check the goal is within tolerance before starting towards goal.

Template Parameters
LogicStateMachineTLogic state machine used to process events

Member Function Documentation

template<class LogicStateMachineT >
bool PositionControlTransitionGuardFunctor_< LogicStateMachineT >::guard ( const PositionYaw event,
UAVSystem robot_system 
)
inlinevirtual

Override this guard function for different sub classes. This function decides whether to call the run function for each state.

Parameters
robot_systemProvides sensor data and allows for controlling hardware
eventEvent triggering the action

Implements GuardFunctor< PositionYaw, UAVSystem, LogicStateMachineT >.


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