KiCad PCB EDA Suite
Loading...
Searching...
No Matches
erc_report.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2023 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software: you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation, either version 3 of the License, or (at your
9 * option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20#ifndef ERC_REPORT_H
21#define ERC_REPORT_H
22
23#include <memory>
24#include <eda_units.h>
25#include <wx/string.h>
26
27class SCHEMATIC;
29
31{
32public:
33 ERC_REPORT( SCHEMATIC* aSchematic, EDA_UNITS aReportUnits );
34
40 wxString GetTextReport();
41
47 bool WriteTextReport( const wxString& aFullFileName );
48
54 bool WriteJsonReport( const wxString& aFullFileName );
55
56private:
59};
60
61
62#endif
EDA_UNITS m_reportUnits
Definition: erc_report.h:58
wxString GetTextReport()
Returns the ERC report in "text" (human readable) format.
Definition: erc_report.cpp:44
SCHEMATIC * m_sch
Definition: erc_report.h:57
bool WriteJsonReport(const wxString &aFullFileName)
Writes a JSON formatted ERC Report to the given file path.
Definition: erc_report.cpp:109
bool WriteTextReport(const wxString &aFullFileName)
Writes the text report also available via GetTextReport directly to a given file path.
Definition: erc_report.cpp:95
Provide an abstract interface of a RC_ITEM* list manager.
Definition: rc_item.h:52
Holds all the data relating to one schematic.
Definition: schematic.h:77
EDA_UNITS
Definition: eda_units.h:46