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

Public Member Functions

 DRC_TASK (API_HANDLER_PCB *aHandler, bool aReportAllTrackErrors, bool aTestFootprints, bool aRequireZonesFilled)
 
void Run () override
 The task runner; called on the main thread.
 
void FillStatus (TaskStatusResponse &aStatus) const override
 
DrcTaskResult 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

bool checkZonesFilled ()
 
bool fetchNetlist ()
 
void buildResult ()
 

Private Attributes

API_HANDLER_PCB * m_handler
 
BOARD * m_board
 
bool m_reportAllTrackErrors
 
bool m_testFootprints
 
bool m_requireZonesFilled
 
TaskState m_state = TS_UNKNOWN
 
std::string m_errorMessage
 
std::unique_ptr< NETLIST > m_netlist
 
std::unique_ptr< BOARD_COMMIT > m_commit
 
std::vector< PCB_MARKER * > m_violationMarkers
 
DrcTaskResult m_result
 

Detailed Description

Definition at line 177 of file api_handler_pcb_tasks.cpp.

Constructor & Destructor Documentation

◆ DRC_TASK()

API_HANDLER_PCB::DRC_TASK::DRC_TASK ( API_HANDLER_PCB * aHandler,
bool aReportAllTrackErrors,
bool aTestFootprints,
bool aRequireZonesFilled )
inline

Member Function Documentation

◆ buildResult()

void API_HANDLER_PCB::DRC_TASK::buildResult ( )
inlineprivate

Definition at line 493 of file api_handler_pcb_tasks.cpp.

References PCB_MARKER::GetSeverity(), m_result, and m_violationMarkers.

Referenced by Run().

◆ checkZonesFilled()

bool API_HANDLER_PCB::DRC_TASK::checkZonesFilled ( )
inlineprivate

Definition at line 398 of file api_handler_pcb_tasks.cpp.

References m_board, m_errorMessage, and m_state.

Referenced by Run().

◆ fetchNetlist()

◆ FillStatus() [1/2]

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

Definition at line 383 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.

◆ Result()

DrcTaskResult API_HANDLER_PCB::DRC_TASK::Result ( ) const
inline

Definition at line 392 of file api_handler_pcb_tasks.cpp.

References m_result.

Referenced by API_HANDLER_PCB::handleGetDrcTaskResult().

◆ Run()

Member Data Documentation

◆ m_board

BOARD* API_HANDLER_PCB::DRC_TASK::m_board
private

Definition at line 534 of file api_handler_pcb_tasks.cpp.

Referenced by checkZonesFilled(), DRC_TASK(), fetchNetlist(), and Run().

◆ m_commit

std::unique_ptr<BOARD_COMMIT> API_HANDLER_PCB::DRC_TASK::m_commit
private

Definition at line 543 of file api_handler_pcb_tasks.cpp.

Referenced by Run().

◆ m_errorMessage

std::string API_HANDLER_PCB::DRC_TASK::m_errorMessage
private

Definition at line 540 of file api_handler_pcb_tasks.cpp.

Referenced by checkZonesFilled(), fetchNetlist(), FillStatus(), and Run().

◆ m_handler

API_HANDLER_PCB* API_HANDLER_PCB::DRC_TASK::m_handler
private

Definition at line 533 of file api_handler_pcb_tasks.cpp.

Referenced by DRC_TASK(), fetchNetlist(), and Run().

◆ m_netlist

std::unique_ptr<NETLIST> API_HANDLER_PCB::DRC_TASK::m_netlist
private

Definition at line 542 of file api_handler_pcb_tasks.cpp.

Referenced by fetchNetlist(), and Run().

◆ m_reportAllTrackErrors

bool API_HANDLER_PCB::DRC_TASK::m_reportAllTrackErrors
private

Definition at line 535 of file api_handler_pcb_tasks.cpp.

Referenced by DRC_TASK(), and Run().

◆ m_requireZonesFilled

bool API_HANDLER_PCB::DRC_TASK::m_requireZonesFilled
private

Definition at line 537 of file api_handler_pcb_tasks.cpp.

Referenced by DRC_TASK(), and Run().

◆ m_result

DrcTaskResult API_HANDLER_PCB::DRC_TASK::m_result
private

Definition at line 545 of file api_handler_pcb_tasks.cpp.

Referenced by buildResult(), and Result().

◆ m_state

TaskState API_HANDLER_PCB::DRC_TASK::m_state = TS_UNKNOWN
private

Definition at line 539 of file api_handler_pcb_tasks.cpp.

Referenced by checkZonesFilled(), fetchNetlist(), FillStatus(), and Run().

◆ m_testFootprints

bool API_HANDLER_PCB::DRC_TASK::m_testFootprints
private

Definition at line 536 of file api_handler_pcb_tasks.cpp.

Referenced by DRC_TASK(), and Run().

◆ m_violationMarkers

std::vector<PCB_MARKER*> API_HANDLER_PCB::DRC_TASK::m_violationMarkers
private

Definition at line 544 of file api_handler_pcb_tasks.cpp.

Referenced by buildResult(), and Run().


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