KiCad PCB EDA Suite
altium_designer_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) 2019 Thomas Pointhuber <thomas.pointhuber@gmx.at>
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, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
29 #ifndef ALTIUM_DESIGNER_PLUGIN_H_
30 #define ALTIUM_DESIGNER_PLUGIN_H_
31 
32 
33 #include <io_mgr.h>
34 
36 {
37 public:
38  // -----<PUBLIC PLUGIN API>--------------------------------------------------
39 
40  const wxString PluginName() const override;
41 
42  BOARD* Load(
43  const wxString& aFileName, BOARD* aAppendToMe, const PROPERTIES* aProperties ) override;
44 
45  const wxString GetFileExtension() const override;
46 
47  long long GetLibraryTimestamp( const wxString& aLibraryPath ) const override
48  {
49  // TODO?
50  return 0;
51  }
52 
53  // -----</PUBLIC PLUGIN API>-------------------------------------------------
54 
57 
58 private:
61 };
62 
63 #endif // ALTIUM_DESIGNER_PLUGIN_H_
PROPERTIES is a name/value tuple with unique names and optional values.
Definition: properties.h:34
BOARD * Load(const wxString &aFileName, BOARD *aAppendToMe, const PROPERTIES *aProperties) override
Function Load loads information from some input file format that this PLUGIN implementation knows abo...
const wxString GetFileExtension() const override
Function GetFileExtension returns the file extension for the PLUGIN.
const wxString PluginName() const override
Function PluginName returns a brief hard coded name for this PLUGIN.
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:180
PLUGIN is a base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:273
long long GetLibraryTimestamp(const wxString &aLibraryPath) const override
Generate a timestamp representing all the files in the library (including the library directory).