KiCad PCB EDA Suite
Loading...
Searching...
No Matches
API_HANDLER_PCB::REFILL_ZONES_TASK Class Referenceabstract
Inheritance diagram for API_HANDLER_PCB::REFILL_ZONES_TASK:
API_TASK

Public Member Functions

 REFILL_ZONES_TASK (API_HANDLER_PCB *aHandler, std::vector< ZONE * > &&aZones)
 
void Run () override
 The task runner; called on the main thread.
 
void FillStatus (TaskStatusResponse &aStatus) const override
 
virtual void FillStatus (kiapi::common::tasks::TaskStatusResponse &aStatus) const =0
 Called after Run() returns; should fill in the result of the run.
 

Private Attributes

API_HANDLER_PCB * m_handler
 
BOARD * m_board
 
std::vector< ZONE * > m_zones
 
TaskState m_state = TS_UNKNOWN
 
std::string m_errorMessage
 

Detailed Description

Definition at line 72 of file api_handler_pcb_tasks.cpp.

Constructor & Destructor Documentation

◆ REFILL_ZONES_TASK()

API_HANDLER_PCB::REFILL_ZONES_TASK::REFILL_ZONES_TASK ( API_HANDLER_PCB * aHandler,
std::vector< ZONE * > && aZones )
inline

Member Function Documentation

◆ FillStatus() [1/2]

void API_HANDLER_PCB::REFILL_ZONES_TASK::FillStatus ( TaskStatusResponse & aStatus) const
inlineoverride

Definition at line 159 of file api_handler_pcb_tasks.cpp.

References m_errorMessage, and m_state.

◆ FillStatus() [2/2]

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

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

◆ Run()

Member Data Documentation

◆ m_board

BOARD* API_HANDLER_PCB::REFILL_ZONES_TASK::m_board
private

Definition at line 170 of file api_handler_pcb_tasks.cpp.

Referenced by REFILL_ZONES_TASK(), and Run().

◆ m_errorMessage

std::string API_HANDLER_PCB::REFILL_ZONES_TASK::m_errorMessage
private

Definition at line 173 of file api_handler_pcb_tasks.cpp.

Referenced by FillStatus(), and Run().

◆ m_handler

API_HANDLER_PCB* API_HANDLER_PCB::REFILL_ZONES_TASK::m_handler
private

Definition at line 169 of file api_handler_pcb_tasks.cpp.

Referenced by REFILL_ZONES_TASK(), and Run().

◆ m_state

TaskState API_HANDLER_PCB::REFILL_ZONES_TASK::m_state = TS_UNKNOWN
private

Definition at line 172 of file api_handler_pcb_tasks.cpp.

Referenced by FillStatus(), and Run().

◆ m_zones

std::vector<ZONE*> API_HANDLER_PCB::REFILL_ZONES_TASK::m_zones
private

Definition at line 171 of file api_handler_pcb_tasks.cpp.

Referenced by REFILL_ZONES_TASK(), and Run().


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