Profiling::TaskStat Class Reference

Helper class to support printing of real-time task information. More...

#include <TaskStat.h>

Public Member Functions

 TaskStat (Print &out)
 Constructor. More...
 
 ~TaskStat ()
 
bool update ()
 Update the report. More...
 

Detailed Description

Helper class to support printing of real-time task information.

Code is refactored from the FreeRTOS Real Time Stats Example.

Requires these SDK configuration settings to be set:

  • FREERTOS_USE_TRACE_FACILITY
  • FREERTOS_GENERATE_RUN_TIME_STATS
  • FREERTOS_VTASKLIST_INCLUDE_COREID (optional)

Constructor & Destructor Documentation

◆ TaskStat()

Profiling::TaskStat::TaskStat ( Print out)

Constructor.

Parameters
outWhere to print reports (e.g. Serial)

◆ ~TaskStat()

Profiling::TaskStat::~TaskStat ( )

Member Function Documentation

◆ update()

bool Profiling::TaskStat::update ( )

Update the report.

Nothing will be output the first time this is called. From then on, the stats will show the difference in task usage from the previous call.


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