KiCad PCB EDA Suite
Loading...
Searching...
No Matches
API_TASK Class Referenceabstract

#include <api_task_scheduler.h>

Inheritance diagram for API_TASK:
API_HANDLER_PCB::DRC_TASK API_HANDLER_PCB::REFILL_ZONES_TASK API_HANDLER_SCH::ERC_TASK

Public Member Functions

virtual ~API_TASK ()=default
 
virtual void Run ()=0
 The task runner; called on the main thread.
 
virtual void FillStatus (kiapi::common::tasks::TaskStatusResponse &aStatus) const =0
 Called after Run() returns; should fill in the result of the run.
 

Detailed Description

Definition at line 44 of file api_task_scheduler.h.

Constructor & Destructor Documentation

◆ ~API_TASK()

virtual API_TASK::~API_TASK ( )
virtualdefault

Member Function Documentation

◆ FillStatus()

virtual void API_TASK::FillStatus ( kiapi::common::tasks::TaskStatusResponse & aStatus) const
pure virtual

Called after Run() returns; should fill in the result of the run.

◆ Run()

virtual void API_TASK::Run ( )
pure virtual

The task runner; called on the main thread.

Implemented in API_HANDLER_PCB::DRC_TASK, API_HANDLER_PCB::REFILL_ZONES_TASK, and API_HANDLER_SCH::ERC_TASK.


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