KiCad PCB EDA Suite
pcad_plugin.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) 2012 Alexander Lunev <al.lunev@yahoo.com>
5  * Copyright (C) 2012 KiCad Developers, see CHANGELOG.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 
30 #ifndef PCAD_PLUGIN_H_
31 #define PCAD_PLUGIN_H_
32 
33 
34 #include <io_mgr.h>
35 
36 class PCAD_PLUGIN : public PLUGIN
37 {
38 public:
39 
40  // -----<PUBLIC PLUGIN API>--------------------------------------------------
41 
42  const wxString PluginName() const override;
43 
44  BOARD* Load( const wxString& aFileName,
45  BOARD* aAppendToMe,
46  const PROPERTIES* aProperties = NULL ) override;
47 
48  const wxString GetFileExtension() const override;
49 
50  // -----</PUBLIC PLUGIN API>-------------------------------------------------
51 
52  PCAD_PLUGIN();
53  ~PCAD_PLUGIN();
54 
55 private:
58 };
59 
60 #endif // PCAD_PLUGIN_H_
BOARD * Load(const wxString &aFileName, BOARD *aAppendToMe, const PROPERTIES *aProperties=NULL) override
Function Load loads information from some input file format that this PLUGIN implementation knows abo...
Definition: pcad_plugin.cpp:70
Class PROPERTIES is a name/value tuple with unique names and optional values.
Definition: properties.h:34
BOARD * m_board
Definition: pcad_plugin.h:57
const PROPERTIES * m_props
Definition: pcad_plugin.h:56
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:166
const wxString GetFileExtension() const override
Function GetFileExtension returns the file extension for the PLUGIN.
Definition: pcad_plugin.cpp:64
Class PLUGIN is a base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:193
const wxString PluginName() const override
Function PluginName returns a brief hard coded name for this PLUGIN.
Definition: pcad_plugin.cpp:58