KiCad PCB EDA Suite
ee_inspection_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 (C) 2019 CERN
5  * Copyright (C) 2019 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #ifndef EE_INSPECTION_TOOL_H
26 #define EE_INSPECTION_TOOL_H
27 
28 #include <boost/optional/optional.hpp>
29 #include <tools/ee_tool_base.h>
30 #include <sch_base_frame.h>
31 
32 
33 class EE_SELECTION_TOOL;
34 class SCH_BASE_FRAME;
35 
36 
37 class EE_INSPECTION_TOOL : public EE_TOOL_BASE<SCH_BASE_FRAME>
38 {
39 public:
42 
44  bool Init() override;
45 
46  int RunERC( const TOOL_EVENT& aEvent );
47  int RunSimulation( const TOOL_EVENT& aEvent );
48 
49  int ShowDatasheet( const TOOL_EVENT& aEvent );
50 
51  int UpdateMessagePanel( const TOOL_EVENT& aEvent );
52 
53 private:
54  void checkPart( LIB_PART* aPart );
55 
57  void setTransitions() override;
58 };
59 
60 #endif /* EE_INSPECTION_TOOL_H */
int RunSimulation(const TOOL_EVENT &aEvent)
void setTransitions() override
int UpdateMessagePanel(const TOOL_EVENT &aEvent)
void checkPart(LIB_PART *aPart)
TOOL_EVENT.
Definition: tool_event.h:171
Define a library symbol object.
int RunERC(const TOOL_EVENT &aEvent)
EE_TOOL_BASE.
Definition: ee_tool_base.h:50
bool Init() override
Function Init() Init() is called once upon a registration of the tool.
int ShowDatasheet(const TOOL_EVENT &aEvent)
A shim class between EDA_DRAW_FRAME and several derived classes: LIB_EDIT_FRAME, LIB_VIEW_FRAME,...