DRC_REPORT Class Reference

#include <drc_report.h>

Public Member Functions
	DRC_REPORT (BOARD *aBoard, EDA_UNITS aReportUnits, std::shared_ptr< RC_ITEMS_PROVIDER > aMarkersProvider, std::shared_ptr< RC_ITEMS_PROVIDER > aRatsnestProvider, std::shared_ptr< RC_ITEMS_PROVIDER > aFpWarningsProvider)
bool	WriteTextReport (const wxString &aFullFileName)
bool	WriteJsonReport (const wxString &aFullFileName)

Private Attributes
BOARD *	m_board
EDA_UNITS	m_reportUnits
std::shared_ptr< RC_ITEMS_PROVIDER >	m_markersProvider
std::shared_ptr< RC_ITEMS_PROVIDER >	m_ratsnestProvider
std::shared_ptr< RC_ITEMS_PROVIDER >	m_fpWarningsProvider

Detailed Description

Definition at line 30 of file drc_report.h.

Constructor & Destructor Documentation

DRC_REPORT()

DRC_REPORT::DRC_REPORT	(	BOARD *	aBoard,
		EDA_UNITS	aReportUnits,
		std::shared_ptr< RC_ITEMS_PROVIDER >	aMarkersProvider,
		std::shared_ptr< RC_ITEMS_PROVIDER >	aRatsnestProvider,
		std::shared_ptr< RC_ITEMS_PROVIDER >	aFpWarningsProvider
	)

Definition at line 33 of file drc_report.cpp.

Member Function Documentation

WriteJsonReport()

bool DRC_REPORT::WriteJsonReport

(

const wxString &

aFullFileName

)

Definition at line 114 of file drc_report.cpp.

References RC_JSON::REPORT_BASE::$schema, RC_JSON::REPORT_BASE::coordinate_units, RC_JSON::REPORT_BASE::date, BOARD::FillItemMap(), BOARD::GetDesignSettings(), BOARD::GetFileName(), GetISO8601CurrentDateTime(), EDA_UNIT_UTILS::GetLabel(), GetMajorMinorPatchVersion(), BOARD_DESIGN_SETTINGS::GetSeverity(), RC_JSON::REPORT_BASE::kicad_version, m_board, m_fpWarningsProvider, m_markersProvider, m_ratsnestProvider, m_reportUnits, pcbIUScale, RPT_SEVERITY_EXCLUSION, RC_JSON::DRC_REPORT::schematic_parity, RC_JSON::REPORT_BASE::source, RC_JSON::DRC_REPORT::unconnected_items, and RC_JSON::DRC_REPORT::violations.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrc(), and DIALOG_DRC::OnSaveReport().

WriteTextReport()

bool DRC_REPORT::WriteTextReport

(

const wxString &

aFullFileName

)

Definition at line 47 of file drc_report.cpp.

References BOARD::FillItemMap(), BOARD::GetDesignSettings(), BOARD::GetFileName(), GetISO8601CurrentDateTime(), BOARD_DESIGN_SETTINGS::GetSeverity(), m_board, m_fpWarningsProvider, m_markersProvider, m_ratsnestProvider, m_reportUnits, pcbIUScale, RPT_SEVERITY_EXCLUSION, and TO_UTF8.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrc(), and DIALOG_DRC::OnSaveReport().

Member Data Documentation

m_board

BOARD* DRC_REPORT::m_board

private

Definition at line 43 of file drc_report.h.

Referenced by WriteJsonReport(), and WriteTextReport().

m_fpWarningsProvider

std::shared_ptr<RC_ITEMS_PROVIDER> DRC_REPORT::m_fpWarningsProvider

private

Definition at line 47 of file drc_report.h.

Referenced by WriteJsonReport(), and WriteTextReport().

m_markersProvider

std::shared_ptr<RC_ITEMS_PROVIDER> DRC_REPORT::m_markersProvider

private

Definition at line 45 of file drc_report.h.

Referenced by WriteJsonReport(), and WriteTextReport().

m_ratsnestProvider

std::shared_ptr<RC_ITEMS_PROVIDER> DRC_REPORT::m_ratsnestProvider

private

Definition at line 46 of file drc_report.h.

Referenced by WriteJsonReport(), and WriteTextReport().

m_reportUnits

EDA_UNITS DRC_REPORT::m_reportUnits

private

Definition at line 44 of file drc_report.h.

Referenced by WriteJsonReport(), and WriteTextReport().

---

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

• drc_report.h
• drc_report.cpp