ICAROUS
All Classes Namespaces Files Functions Variables Enumerations Enumerator Macros Modules Pages
Public Member Functions | Public Attributes | List of all members
MergingHandler Class Reference

Merging handler.

#include <Handlers.hpp>

Inheritance diagram for MergingHandler:
EventHandler< CognitionState_t >

Public Member Functions

retVal_e Initialize (CognitionState_t *state)
 perform all initialization activities for a specific task More...
 
retVal_e Execute (CognitionState_t *state)
 perform the core activity More...
 
retVal_e Terminate (CognitionState_t *state)
 perform termination activities More...
 
- Public Member Functions inherited from EventHandler< CognitionState_t >
bool RunEvent (CognitionState_t *state)
 Run this event. More...
 
void ExecuteHandler (std::shared_ptr< EventHandler< CognitionState_t > > hdl, std::string eventName, float priorityNew=0)
 Spawn another handler. More...
 

Public Attributes

bool mergingSpeedChange = false
 
- Public Attributes inherited from EventHandler< CognitionState_t >
std::string eventName
 event name
 
execState_e execState
 current execution state for this handler
 
std::list< std::shared_ptr< EventHandler< CognitionState_t > > > children
 list of child handlers
 
float priority
 current execution priority
 
float defaultPriority
 user defined priority for this handler
 

Additional Inherited Members

- Public Types inherited from EventHandler< CognitionState_t >
enum  execState_e
 enumerations for the execution state More...
 
enum  retVal_e
 enumerations for the return state
 

Member Function Documentation

◆ Execute()

retVal_e MergingHandler::Execute ( CognitionState_t state)
inlinevirtual
Parameters
state
Returns
retVal_e

We just keep track of merging. This ensures we don't execute unnecessary handlers during merging.

Reimplemented from EventHandler< CognitionState_t >.

◆ Initialize()

retVal_e MergingHandler::Initialize ( CognitionState_t state)
inlinevirtual
Parameters
state
Returns
retVal_e

Reimplemented from EventHandler< CognitionState_t >.

◆ Terminate()

retVal_e MergingHandler::Terminate ( CognitionState_t state)
inlinevirtual
Parameters
state
Returns
retVal_e

Upon completion of merging, switch to the nominal path if we've changed speeds

Reimplemented from EventHandler< CognitionState_t >.


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