ERC_REPORT Class Reference

#include <erc_report.h>

Public Member Functions
	ERC_REPORT (SCHEMATIC *aSchematic, EDA_UNITS aReportUnits, std::shared_ptr< RC_ITEMS_PROVIDER > aMarkersProvider=nullptr)
wxString	GetTextReport ()
	Returns the ERC report in "text" (human readable) format in the C-locale.
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 in the c-locale.

Private Attributes
SCHEMATIC *	m_sch
EDA_UNITS	m_reportUnits
std::shared_ptr< RC_ITEMS_PROVIDER >	m_markersProvider
int	m_reportedSeverities

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,
		std::shared_ptr< RC_ITEMS_PROVIDER >	aMarkersProvider = nullptr )

Definition at line 39 of file erc_report.cpp.

References m_markersProvider, m_reportedSeverities, m_reportUnits, m_sch, move, RPT_SEVERITY_ERROR, and RPT_SEVERITY_WARNING.

Member Function Documentation

GetTextReport()

wxString ERC_REPORT::GetTextReport

(

)

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

Returns

The complete report

Definition at line 58 of file erc_report.cpp.

References SCH_SHEET_LIST::FillItemMap(), formatSeverities(), GetISO8601CurrentDateTime(), ERC_ITEM::GetItemsWithSeverities(), ERC_SETTINGS::GetSeverity(), m_markersProvider, m_reportedSeverities, m_reportUnits, m_sch, RPT_SEVERITY_ERROR, RPT_SEVERITY_IGNORE, RPT_SEVERITY_WARNING, and schIUScale.

Referenced by BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), 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 in the c-locale.

Returns

True if the file write completed successfully, false otherwise

Definition at line 157 of file erc_report.cpp.

References RC_JSON::REPORT_BASE::$schema, RC_JSON::REPORT_BASE::coordinate_units, RC_JSON::REPORT_BASE::date, RC_JSON::IGNORED_CHECK::description, SCH_SHEET_LIST::FillItemMap(), GetISO8601CurrentDateTime(), ERC_ITEM::GetItemsWithSeverities(), EDA_UNIT_UTILS::GetLabel(), GetMajorMinorPatchVersion(), ERC_SETTINGS::GetSeverity(), RC_JSON::ERC_REPORT::ignored_checks, RC_JSON::ERC_REPORT::included_severities, RC_JSON::IGNORED_CHECK::key, RC_JSON::REPORT_BASE::kicad_version, m_markersProvider, m_reportedSeverities, m_reportUnits, m_sch, pcbIUScale, RPT_SEVERITY_ERROR, RPT_SEVERITY_EXCLUSION, RPT_SEVERITY_IGNORE, RPT_SEVERITY_WARNING, 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 143 of file erc_report.cpp.

References GetTextReport().

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

Member Data Documentation

m_markersProvider

std::shared_ptr<RC_ITEMS_PROVIDER> ERC_REPORT::m_markersProvider

private

Definition at line 60 of file erc_report.h.

Referenced by ERC_REPORT(), GetTextReport(), and WriteJsonReport().

m_reportedSeverities

int ERC_REPORT::m_reportedSeverities

private

Definition at line 61 of file erc_report.h.

Referenced by ERC_REPORT(), GetTextReport(), and WriteJsonReport().

m_reportUnits

EDA_UNITS ERC_REPORT::m_reportUnits

private

Definition at line 59 of file erc_report.h.

Referenced by ERC_REPORT(), GetTextReport(), and WriteJsonReport().

m_sch

SCHEMATIC* ERC_REPORT::m_sch

private

Definition at line 58 of file erc_report.h.

Referenced by ERC_REPORT(), GetTextReport(), and WriteJsonReport().

---

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

• erc_report.h
• erc_report.cpp