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 <[email protected]>
5  * Copyright (C) 2012-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 PCAD_PLUGIN_H_
31 #define PCAD_PLUGIN_H_
32 
33 #include <io_mgr.h>
34 
35 class PCAD_PLUGIN : public PLUGIN
36 {
37 public:
38  PCAD_PLUGIN();
39  ~PCAD_PLUGIN();
40 
41  const wxString PluginName() const override;
42 
43  BOARD* Load( const wxString& aFileName,
44  BOARD* aAppendToMe,
45  const PROPERTIES* aProperties = nullptr,
46  PROJECT* aProject = nullptr,
47  PROGRESS_REPORTER* aProgressReporter = nullptr ) override;
48 
49  const wxString GetFileExtension() const override;
50 
51  long long GetLibraryTimestamp( const wxString& aLibraryPath ) const override
52  {
53  // No support for libraries....
54  return 0;
55  }
56 
57 private:
60 };
61 
62 #endif // PCAD_PLUGIN_H_
long long GetLibraryTimestamp(const wxString &aLibraryPath) const override
Generate a timestamp representing all the files in the library (including the library directory).
Definition: pcad_plugin.h:51
Container for project specific data.
Definition: project.h:62
A progress reporter interface for use in multi-threaded environments.
A name/value tuple with unique names and optional values.
Definition: properties.h:33
BOARD * m_board
Definition: pcad_plugin.h:59
const PROPERTIES * m_props
Definition: pcad_plugin.h:58
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:191
BOARD * Load(const wxString &aFileName, BOARD *aAppendToMe, const PROPERTIES *aProperties=nullptr, PROJECT *aProject=nullptr, PROGRESS_REPORTER *aProgressReporter=nullptr) override
Load information from some input file format that this PLUGIN implementation knows about into either ...
Definition: pcad_plugin.cpp:69
const wxString GetFileExtension() const override
Returns the file extension for the PLUGIN.
Definition: pcad_plugin.cpp:63
A base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:269
const wxString PluginName() const override
Return a brief hard coded name for this PLUGIN.
Definition: pcad_plugin.cpp:57