KiCad PCB EDA Suite
altium_circuit_maker_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  * Copyright (C) 2020 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 
30 #ifndef ALTIUM_CIRCUIT_MAKER_PLUGIN_H_
31 #define ALTIUM_CIRCUIT_MAKER_PLUGIN_H_
32 
33 
34 #include <io_mgr.h>
35 
37 {
38 public:
39  const wxString PluginName() const override;
40 
41  BOARD* Load( const wxString& aFileName, BOARD* aAppendToMe, const PROPERTIES* aProperties,
42  PROJECT* aProject = nullptr ) override;
43 
44  const wxString GetFileExtension() const override;
45 
46  long long GetLibraryTimestamp( const wxString& aLibraryPath ) const override
47  {
48  // TODO?
49  return 0;
50  }
51 
54 
55 private:
58 };
59 
60 #endif // ALTIUM_CIRCUIT_MAKER_PLUGIN_H_
const wxString PluginName() const override
Return a brief hard coded name for this PLUGIN.
Container for project specific data.
Definition: project.h:62
BOARD * Load(const wxString &aFileName, BOARD *aAppendToMe, const PROPERTIES *aProperties, PROJECT *aProject=nullptr) override
Load information from some input file format that this PLUGIN implementation knows about into either ...
A name/value tuple with unique names and optional values.
Definition: properties.h:33
long long GetLibraryTimestamp(const wxString &aLibraryPath) const override
Generate a timestamp representing all the files in the library (including the library directory).
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:189
A base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:267
const wxString GetFileExtension() const override
Returns the file extension for the PLUGIN.