KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcb_io_altium_designer.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 PCB_IO_ALTIUM_DESIGNER_H_
26#define PCB_IO_ALTIUM_DESIGNER_H_
27
28#include <pcb_io/pcb_io.h>
29#include <pcb_io/pcb_io_mgr.h>
31
32#include <map>
33#include <memory>
34
36
38{
39public:
40 // -----<PUBLIC PCB_IO API>--------------------------------------------------
42 {
43 return IO_BASE::IO_FILE_DESC( _HKI( "Altium Designer PCB files" ), { "PcbDoc" } );
44 }
45
47 {
48 return IO_BASE::IO_FILE_DESC( _HKI( "Altium PCB Library or Integrated Library" ),
49 { "PcbLib", "IntLib" } );
50 }
51
52 bool CanReadBoard( const wxString& aFileName ) const override;
53 bool CanReadLibrary( const wxString& aFileName ) const override;
54
55 BOARD* LoadBoard( const wxString& aFileName, BOARD* aAppendToMe,
56 const STRING_UTF8_MAP* aProperties, PROJECT* aProject = nullptr ) override;
57
58 long long GetLibraryTimestamp( const wxString& aLibraryPath ) const override;
59
60 void FootprintEnumerate( wxArrayString& aFootprintNames, const wxString& aLibraryPath,
61 bool aBestEfforts, const STRING_UTF8_MAP* aProperties = nullptr ) override;
62
63 FOOTPRINT* FootprintLoad( const wxString& aLibraryPath, const wxString& aFootprintName,
64 bool aKeepUUID = false,
65 const STRING_UTF8_MAP* aProperties = nullptr ) override;
66
67 //bool FootprintExists( const wxString& aLibraryPath, const wxString& aFootprintName, const PROPERTIES* aProperties = nullptr );
68
69 bool IsLibraryWritable( const wxString& aLibraryPath ) override { return false; }
70
71 // -----</PUBLIC PCB_IO API>-------------------------------------------------
72
75
76 static bool checkFileHeader( const wxString& aFileName );
77
84 static std::map<wxString, PCB_LAYER_ID> DefaultLayerMappingCallback(
85 const std::vector<INPUT_LAYER_DESC>& aInputLayerDescriptionVector );
86
87private:
88 std::map<wxString, std::vector<std::unique_ptr<ALTIUM_COMPOUND_FILE>>> m_fplibFiles;
89
90 void loadAltiumLibrary( const wxString& aLibraryPath );
91};
92
93#endif // PCB_IO_ALTIUM_DESIGNER_H_
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:282
Plugin class for import plugins that support remappable layers.
long long GetLibraryTimestamp(const wxString &aLibraryPath) const override
Generate a timestamp representing all the files in the library (including the library directory).
BOARD * LoadBoard(const wxString &aFileName, BOARD *aAppendToMe, const STRING_UTF8_MAP *aProperties, PROJECT *aProject=nullptr) override
Load information from some input file format that this PCB_IO implementation knows about into either ...
FOOTPRINT * FootprintLoad(const wxString &aLibraryPath, const wxString &aFootprintName, bool aKeepUUID=false, const STRING_UTF8_MAP *aProperties=nullptr) override
Load a footprint having aFootprintName from the aLibraryPath containing a library format that this PC...
static bool checkFileHeader(const wxString &aFileName)
const IO_BASE::IO_FILE_DESC GetBoardFileDesc() const override
Returns board file description for the PCB_IO.
PCB_IO_ALTIUM_DESIGNER()
Pcbnew PLUGIN for Altium *.PcbDoc format.
bool CanReadBoard(const wxString &aFileName) const override
Checks if this PCB_IO can read the specified board file.
void loadAltiumLibrary(const wxString &aLibraryPath)
static std::map< wxString, PCB_LAYER_ID > DefaultLayerMappingCallback(const std::vector< INPUT_LAYER_DESC > &aInputLayerDescriptionVector)
Return the automapped layers.
bool IsLibraryWritable(const wxString &aLibraryPath) override
Return true if the library at aLibraryPath is writable.
void FootprintEnumerate(wxArrayString &aFootprintNames, const wxString &aLibraryPath, bool aBestEfforts, const STRING_UTF8_MAP *aProperties=nullptr) override
Return a list of footprint names contained within the library at aLibraryPath.
const IO_BASE::IO_FILE_DESC GetLibraryDesc() const override
Get the descriptor for the library container that this IO plugin operates on.
std::map< wxString, std::vector< std::unique_ptr< ALTIUM_COMPOUND_FILE > > > m_fplibFiles
bool CanReadLibrary(const wxString &aFileName) const override
Checks if this IO object can read the specified library file/directory.
A base class that BOARD loading and saving plugins should derive from.
Definition: pcb_io.h:72
Container for project specific data.
Definition: project.h:62
A name/value tuple with unique names and optional values.
#define _HKI(x)
Container that describes file type info.
Definition: io_base.h:40