MainLoop Class Reference

#include <main_loop_controller.h>

Inheritance diagram for MainLoop:

Collaboration diagram for MainLoop:

Public Member Functions
	MainLoop ()
void	PeriodicTask (efitick_t nowNt) override
	Called periodically. Override this method to do work for your controller.
Public Member Functions inherited from PeriodicController< 1024 >
	PeriodicController (const char *name, tprio_t priority, float frequencyHz)
	PeriodicController (const char *name)
void	setPeriod (int periodMs)
Public Member Functions inherited from ThreadController< TStackSize >
	ThreadController (const char *name, tprio_t priority)
void	start ()
	Start the thread.
void	stop ()
	Request thread termination and waits for termination.

Private Member Functions
template<LoopPeriod TFlag>
LoopPeriod	makePeriodFlag () const
LoopPeriod	makePeriodFlags ()

Private Attributes
int	m_cycleCounter = 0

Additional Inherited Members
Protected Member Functions inherited from PeriodicController< 1024 >
virtual void	OnStarted ()
	Called before running the periodic task. Optionally override this method to set up.
Protected Member Functions inherited from ThreadController< TStackSize >
void	main () override
Protected Attributes inherited from ThreadController< TStackSize >
const char *const	m_name

Detailed Description

Definition at line 21 of file main_loop_controller.h.

Constructor & Destructor Documentation

MainLoop()

MainLoop::MainLoop

(

)

Definition at line 10 of file main_loop.cpp.

    : PeriodicController("MainLoop", PRIO_MAIN_LOOP, MAIN_LOOP_RATE)
{
}

Member Function Documentation

makePeriodFlag()

template<LoopPeriod TFlag>

LoopPeriod MainLoop::makePeriodFlag ( ) const

private

Definition at line 16 of file main_loop.cpp.

                                          {
    if (m_cycleCounter % loopCounts<TFlag>() == 0) {
        return TFlag;
    } else {
        return LoopPeriod::None;
    }
}

makePeriodFlags()

LoopPeriod MainLoop::makePeriodFlags ( )

private

Definition at line 24 of file main_loop.cpp.

                                     {
    if (m_cycleCounter >= MAIN_LOOP_RATE) {
        m_cycleCounter = 0;
    }
 
    LoopPeriod lp = LoopPeriod::None;
    lp |= makePeriodFlag<LoopPeriod::Period1000hz>();
    lp |= makePeriodFlag<LoopPeriod::Period500hz>();
    lp |= makePeriodFlag<LoopPeriod::Period250hz>();
    lp |= makePeriodFlag<LoopPeriod::Period200hz>();
    lp |= makePeriodFlag<LoopPeriod::Period20hz>();
 
    m_cycleCounter++;
 
    return lp;
}

Referenced by PeriodicTask().

Here is the caller graph for this function:

PeriodicTask()

void MainLoop::PeriodicTask ( efitick_t  nowNt )

overridevirtual

Called periodically. Override this method to do work for your controller.

Implements PeriodicController< 1024 >.

Definition at line 41 of file main_loop.cpp.

                                           {
    ScopePerf perf(PE::MainLoop);
 
    LoopPeriod currentLoopPeriod = makePeriodFlags();
 
#if HAL_USE_ADC
    if (currentLoopPeriod & ADC_UPDATE_RATE) {
        adcInputsUpdateSubscribers(nowNt);
    }
#endif // HAL_USE_ADC
 
#if EFI_ELECTRONIC_THROTTLE_BODY
    if (currentLoopPeriod & ETB_UPDATE_RATE) {
        // TODO: main_loop etb callback
    }
#endif // EFI_ELECTRONIC_THROTTLE_BODY
 
    if (currentLoopPeriod & SLOW_CALLBACK_RATE) {
        //TODO: main_loop slow callback
    }
 
    if (currentLoopPeriod & FAST_CALLBACK_RATE) {
       //TODO: main_loop fast callback
    }
}

Here is the call graph for this function:

Field Documentation

m_cycleCounter

int MainLoop::m_cycleCounter = 0

private

Definition at line 35 of file main_loop_controller.h.

Referenced by makePeriodFlag(), and makePeriodFlags().

---

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

• controllers/core/main_loop_controller.h
• controllers/core/main_loop.cpp