KiCad PCB EDA Suite
Loading...
Searching...
No Matches
ERC_REPORT Class Reference

#include <erc_report.h>

Public Member Functions

 ERC_REPORT (SCHEMATIC *aSchematic, EDA_UNITS aReportUnits)
 
wxString GetTextReport ()
 Returns the ERC report in "text" (human readable) format. More...
 
bool WriteTextReport (const wxString &aFullFileName)
 Writes the text report also available via GetTextReport directly to a given file path. More...
 
bool WriteJsonReport (const wxString &aFullFileName)
 Writes a JSON formatted ERC Report to the given file path. More...
 

Private Attributes

SCHEMATICm_sch
 
EDA_UNITS m_reportUnits
 

Detailed Description

Definition at line 30 of file erc_report.h.

Constructor & Destructor Documentation

◆ ERC_REPORT()

ERC_REPORT::ERC_REPORT ( SCHEMATIC aSchematic,
EDA_UNITS  aReportUnits 
)

Definition at line 37 of file erc_report.cpp.

Member Function Documentation

◆ GetTextReport()

◆ WriteJsonReport()

◆ WriteTextReport()

bool ERC_REPORT::WriteTextReport ( const wxString &  aFullFileName)

Writes the text report also available via GetTextReport directly to a given file path.

Returns
True if the file write completed successfully, false otherwise

Definition at line 95 of file erc_report.cpp.

References GetTextReport().

Referenced by EESCHEMA_JOBS_HANDLER::JobSchErc(), and DIALOG_ERC::OnSaveReport().

Member Data Documentation

◆ m_reportUnits

EDA_UNITS ERC_REPORT::m_reportUnits
private

Definition at line 58 of file erc_report.h.

Referenced by GetTextReport(), and WriteJsonReport().

◆ m_sch

SCHEMATIC* ERC_REPORT::m_sch
private

Definition at line 57 of file erc_report.h.

Referenced by GetTextReport(), and WriteJsonReport().


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