KiCad PCB EDA Suite
Loading...
Searching...
No Matches
altium_circuit_studio_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 <[email protected]>
5 * Copyright (C) 2023 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 ALTIUM_CIRCUIT_STUDIO_PLUGIN_H_
26#define ALTIUM_CIRCUIT_STUDIO_PLUGIN_H_
27
28
29#include <io_mgr.h>
30
32{
33public:
34 const wxString PluginName() const override;
35
36 PLUGIN_FILE_DESC GetBoardFileDesc() const override;
37
38 bool CanReadBoard( const wxString& aFileName ) const override;
39
40 BOARD* LoadBoard( const wxString& aFileName, BOARD* aAppendToMe,
41 const STRING_UTF8_MAP* aProperties, PROJECT* aProject,
42 PROGRESS_REPORTER* aProgressReporter = nullptr ) override;
43
44 long long GetLibraryTimestamp( const wxString& aLibraryPath ) const override
45 {
46 // TODO?
47 return 0;
48 }
49
52
53private:
56};
57
58#endif // ALTIUM_CIRCUIT_STUDIO_PLUGIN_H_
PLUGIN_FILE_DESC GetBoardFileDesc() const override
Returns board file description for the PLUGIN.
BOARD * LoadBoard(const wxString &aFileName, BOARD *aAppendToMe, const STRING_UTF8_MAP *aProperties, PROJECT *aProject, PROGRESS_REPORTER *aProgressReporter=nullptr) override
Load information from some input file format that this PLUGIN implementation knows about into either ...
long long GetLibraryTimestamp(const wxString &aLibraryPath) const override
Generate a timestamp representing all the files in the library (including the library directory).
bool CanReadBoard(const wxString &aFileName) const override
Checks if this PLUGIN can read the specified board file.
const wxString PluginName() const override
Return a brief hard coded name for this PLUGIN.
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:271
A base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:270
A progress reporter interface for use in multi-threaded environments.
Container for project specific data.
Definition: project.h:62
A name/value tuple with unique names and optional values.
Container that describes file type info.