KiCad PCB EDA Suite
Loading...
Searching...
No Matches
drc_tool.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 The KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <https://www.gnu.org/licenses/>.
18 */
19
20#ifndef DRC_TOOL_H
21#define DRC_TOOL_H
22
23#include <board_commit.h>
24#include <board.h>
25#include <pcb_marker.h>
26#include <geometry/seg.h>
28#include <memory>
29#include <vector>
30#include <tools/pcb_tool_base.h>
31
32
33#define DRC_TOOL_NAME "pcbnew.DRCTool"
34
35
36class PCB_EDIT_FRAME;
37class DIALOG_DRC;
38class DRC_ITEM;
40class DRC_ENGINE;
41
42
43class DRC_TOOL : public PCB_TOOL_BASE
44{
45public:
46 DRC_TOOL();
47 ~DRC_TOOL();
48
50 void Reset( RESET_REASON aReason ) override;
51
58 void ShowDRCDialog( wxWindow* aParent );
59
60 int ShowDRCDialog( const TOOL_EVENT& aEvent );
61
63
67 bool IsDRCDialogShown();
68
72 bool IsDRCRunning() const { return m_drcRunning; }
73
77 void DestroyDRCDialog();
78
79 std::shared_ptr<DRC_ENGINE> GetDRCEngine() { return m_drcEngine; }
80
84 void RunTests( PROGRESS_REPORTER* aProgressReporter, bool aRefillZones,
85 bool aReportAllTrackErrors, bool aTestFootprints );
86
87 int PrevMarker( const TOOL_EVENT& aEvent );
88 int NextMarker( const TOOL_EVENT& aEvent );
89 int CrossProbe( const TOOL_EVENT& aEvent );
90
95 void CrossProbe( const PCB_MARKER* aMarker );
96
97 int ExcludeMarker( const TOOL_EVENT& aEvent );
98
99 wxString FixDRCErrorMenuText( const std::shared_ptr<RC_ITEM>& aDRCItem );
100 void FixDRCError( const std::shared_ptr<RC_ITEM>& aDRCItem );
101
102private:
104 void setTransitions() override;
105
109 void updatePointers( bool aDRCWasCancelled );
110
111 EDA_UNITS userUnits() const { return m_editFrame->GetUserUnits(); }
112
113private:
118 std::shared_ptr<DRC_ENGINE> m_drcEngine;
119};
120
121
122#endif // DRC_TOOL_H
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:411
Design Rule Checker object that performs all the DRC tests.
Definition drc_engine.h:129
EDA_UNITS userUnits() const
Definition drc_tool.h:111
void updatePointers(bool aDRCWasCancelled)
Update needed pointers from the one pointer which is known not to change.
Definition drc_tool.cpp:221
void ShowDRCDialog(wxWindow *aParent)
Opens the DRC dialog.
Definition drc_tool.cpp:72
void FixDRCError(const std::shared_ptr< RC_ITEM > &aDRCItem)
Definition drc_tool.cpp:358
int NextMarker(const TOOL_EVENT &aEvent)
Definition drc_tool.cpp:250
wxString FixDRCErrorMenuText(const std::shared_ptr< RC_ITEM > &aDRCItem)
Definition drc_tool.cpp:300
void DestroyDRCDialog()
Close and free the DRC dialog.
Definition drc_tool.cpp:123
std::shared_ptr< DRC_ENGINE > GetDRCEngine()
Definition drc_tool.h:79
DIALOG_DRC * m_drcDialog
Definition drc_tool.h:116
PCB_EDIT_FRAME * m_editFrame
Definition drc_tool.h:114
DIALOG_DRC * GetDRCDialog()
Definition drc_tool.h:62
bool IsDRCDialogShown()
Check to see if the DRC_TOOL dialog is currently shown.
Definition drc_tool.cpp:114
int CrossProbe(const TOOL_EVENT &aEvent)
Definition drc_tool.cpp:267
bool IsDRCRunning() const
Check to see if the DRC engine is running the tests.
Definition drc_tool.h:72
int ExcludeMarker(const TOOL_EVENT &aEvent)
Definition drc_tool.cpp:291
void setTransitions() override
Set up handlers for various events.
Definition drc_tool.cpp:406
BOARD * m_pcb
Definition drc_tool.h:115
int PrevMarker(const TOOL_EVENT &aEvent)
Definition drc_tool.cpp:233
bool m_drcRunning
Definition drc_tool.h:117
void RunTests(PROGRESS_REPORTER *aProgressReporter, bool aRefillZones, bool aReportAllTrackErrors, bool aTestFootprints)
Run the DRC tests.
Definition drc_tool.cpp:133
std::shared_ptr< DRC_ENGINE > m_drcEngine
Definition drc_tool.h:118
The main frame for Pcbnew.
PCB_TOOL_BASE(TOOL_ID aId, const std::string &aName)
Constructor.
A progress reporter interface for use in multi-threaded environments.
RESET_REASON
Determine the reason of reset for a tool.
Definition tool_base.h:74
Generic, UI-independent tool event.
Definition tool_event.h:167
Multi-thread safe progress reporter dialog, intended for use of tasks that parallel reporting back of...
EDA_UNITS
Definition eda_units.h:45
void Reset() override