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.
bool	WriteTextReport (const wxString &aFullFileName)
	Writes the text report also available via GetTextReport directly to a given file path.
bool	WriteJsonReport (const wxString &aFullFileName)
	Writes a JSON formatted ERC Report to the given file path.

Private Attributes
SCHEMATIC *	m_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()

wxString ERC_REPORT::GetTextReport

(

)

Returns the ERC report in "text" (human readable) format.

Returns

The complete report

Definition at line 44 of file erc_report.cpp.

References _, SCHEMATIC::BuildSheetListSortedByPageNumbers(), SCHEMATIC::ErcSettings(), SCH_SHEET_LIST::FillItemMap(), RC_ITEM::GetErrorCode(), GetISO8601CurrentDateTime(), MARKER_BASE::GetMarkerType(), MARKER_BASE::GetRCItem(), ERC_SETTINGS::GetSeverity(), m_reportUnits, m_sch, MARKER_BASE::MARKER_ERC, RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, SCH_MARKER_T, and schIUScale.

Referenced by BOOST_FIXTURE_TEST_CASE(), and WriteTextReport().

WriteJsonReport()

bool ERC_REPORT::WriteJsonReport

(

const wxString &

aFullFileName

)

Writes a JSON formatted ERC Report to the given file path.

Returns

True if the file write completed successfully, false otherwise

Definition at line 109 of file erc_report.cpp.

References RC_JSON::REPORT_BASE::$schema, RC_JSON::REPORT_BASE::coordinate_units, RC_JSON::REPORT_BASE::date, SCHEMATIC::ErcSettings(), SCH_SHEET_LIST::FillItemMap(), RC_ITEM::GetErrorCode(), SCHEMATIC::GetFileName(), GetISO8601CurrentDateTime(), EDA_UNIT_UTILS::GetLabel(), GetMajorMinorPatchVersion(), MARKER_BASE::GetMarkerType(), MARKER_BASE::GetRCItem(), ERC_SETTINGS::GetSeverity(), SCHEMATIC::Hierarchy(), RC_JSON::REPORT_BASE::kicad_version, m_reportUnits, m_sch, MARKER_BASE::MARKER_ERC, pcbIUScale, SCH_MARKER_T, RC_JSON::ERC_REPORT::sheets, and RC_JSON::REPORT_BASE::source.

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

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:

• erc_report.h
• erc_report.cpp