KiCad PCB EDA Suite
Loading...
Searching...
No Matches
drc_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 DRC_REPORT_H
21#define DRC_REPORT_H
22
23#include <memory>
24#include <eda_units.h>
25#include <wx/string.h>
26
27class BOARD;
29
31{
32public:
33 DRC_REPORT( BOARD* aBoard,
34 EDA_UNITS aReportUnits,
35 std::shared_ptr<RC_ITEMS_PROVIDER> aMarkersProvider,
36 std::shared_ptr<RC_ITEMS_PROVIDER> aRatsnestProvider,
37 std::shared_ptr<RC_ITEMS_PROVIDER> aFpWarningsProvider );
38
39 bool WriteTextReport( const wxString& aFullFileName );
40 bool WriteJsonReport( const wxString& aFullFileName );
41
42private:
45 std::shared_ptr<RC_ITEMS_PROVIDER> m_markersProvider;
46 std::shared_ptr<RC_ITEMS_PROVIDER> m_ratsnestProvider;
47 std::shared_ptr<RC_ITEMS_PROVIDER> m_fpWarningsProvider;
48};
49
50
51#endif
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:282
std::shared_ptr< RC_ITEMS_PROVIDER > m_ratsnestProvider
Definition: drc_report.h:46
bool WriteJsonReport(const wxString &aFullFileName)
Definition: drc_report.cpp:114
BOARD * m_board
Definition: drc_report.h:43
std::shared_ptr< RC_ITEMS_PROVIDER > m_markersProvider
Definition: drc_report.h:45
bool WriteTextReport(const wxString &aFullFileName)
Definition: drc_report.cpp:47
EDA_UNITS m_reportUnits
Definition: drc_report.h:44
std::shared_ptr< RC_ITEMS_PROVIDER > m_fpWarningsProvider
Definition: drc_report.h:47
Provide an abstract interface of a RC_ITEM* list manager.
Definition: rc_item.h:52
EDA_UNITS
Definition: eda_units.h:46