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

Public Member Functions

 ERC_TASK (API_HANDLER_SCH *aHandler, SCHEMATIC *aSchematic)
 
void Run () override
 The task runner; called on the main thread.
 
void FillStatus (TaskStatusResponse &aStatus) const override
 
ErcTaskResult Result () const
 
virtual void FillStatus (kiapi::common::tasks::TaskStatusResponse &aStatus) const =0
 Called after Run() returns; should fill in the result of the run.
 

Private Member Functions

void buildResult ()
 

Private Attributes

API_HANDLER_SCH * m_handler
 
SCHEMATIC * m_schematic
 
TaskState m_state = TS_UNKNOWN
 
std::string m_errorMessage
 
ErcTaskResult m_result
 

Detailed Description

Definition at line 62 of file api_handler_sch_tasks.cpp.

Constructor & Destructor Documentation

◆ ERC_TASK()

API_HANDLER_SCH::ERC_TASK::ERC_TASK ( API_HANDLER_SCH * aHandler,
SCHEMATIC * aSchematic )
inline

Member Function Documentation

◆ buildResult()

void API_HANDLER_SCH::ERC_TASK::buildResult ( )
inlineprivate

◆ FillStatus() [1/2]

void API_HANDLER_SCH::ERC_TASK::FillStatus ( TaskStatusResponse & aStatus) const
inlineoverride

Definition at line 122 of file api_handler_sch_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.

◆ Result()

ErcTaskResult API_HANDLER_SCH::ERC_TASK::Result ( ) const
inline

Definition at line 131 of file api_handler_sch_tasks.cpp.

References m_result.

Referenced by API_HANDLER_SCH::handleGetErcTaskResult().

◆ Run()

Member Data Documentation

◆ m_errorMessage

std::string API_HANDLER_SCH::ERC_TASK::m_errorMessage
private

Definition at line 191 of file api_handler_sch_tasks.cpp.

Referenced by FillStatus().

◆ m_handler

API_HANDLER_SCH* API_HANDLER_SCH::ERC_TASK::m_handler
private

Definition at line 187 of file api_handler_sch_tasks.cpp.

Referenced by ERC_TASK(), and Run().

◆ m_result

ErcTaskResult API_HANDLER_SCH::ERC_TASK::m_result
private

Definition at line 193 of file api_handler_sch_tasks.cpp.

Referenced by buildResult(), and Result().

◆ m_schematic

SCHEMATIC* API_HANDLER_SCH::ERC_TASK::m_schematic
private

Definition at line 188 of file api_handler_sch_tasks.cpp.

Referenced by buildResult(), ERC_TASK(), and Run().

◆ m_state

TaskState API_HANDLER_SCH::ERC_TASK::m_state = TS_UNKNOWN
private

Definition at line 190 of file api_handler_sch_tasks.cpp.

Referenced by FillStatus().


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