KiCad PCB EDA Suite
Loading...
Searching...
No Matches
sim_lib_mgr.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) 2022 Mikolaj Wielgus
5 * Copyright (C) 2022-2024 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 3
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 * https://www.gnu.org/licenses/gpl-3.0.html
20 * or you may search the http://www.gnu.org website for the version 3 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 SIM_LIB_MGR_H
26#define SIM_LIB_MGR_H
27
28#include <map>
29#include <vector>
30
31#include <sim/sim_library.h>
32#include <sim/sim_model.h>
33
34class PROJECT;
35class SCH_SYMBOL;
36
37
39{
40public:
41 SIM_LIB_MGR( const PROJECT* aPrj );
42 virtual ~SIM_LIB_MGR() = default;
43
45
46 void Clear();
47
48 void SetLibrary( const wxString& aLibraryPath, REPORTER& aReporter );
49
50 SIM_MODEL& CreateModel( SIM_MODEL::TYPE aType, const std::vector<SCH_PIN*>& aPins,
51 REPORTER& aReporter );
52
53 SIM_MODEL& CreateModel( const SIM_MODEL* aBaseModel, const std::vector<SCH_PIN*>& aPins,
54 REPORTER& aReporter );
55
56 SIM_MODEL& CreateModel( const SIM_MODEL* aBaseModel, const std::vector<SCH_PIN*>& aPins,
57 const std::vector<SCH_FIELD>& aFields, REPORTER& aReporter );
58
59 // TODO: The argument can be made const.
60 SIM_LIBRARY::MODEL CreateModel( const SCH_SHEET_PATH* aSheetPath, SCH_SYMBOL& aSymbol,
61 REPORTER& aReporter );
62
63 SIM_LIBRARY::MODEL CreateModel( const std::vector<SCH_FIELD>& aFields,
64 const std::vector<SCH_PIN*>& aPins, bool aResolved,
65 REPORTER& aReporter );
66
67 SIM_LIBRARY::MODEL CreateModel( const wxString& aLibraryPath,
68 const std::string& aBaseModelName,
69 const std::vector<SCH_FIELD>& aFields,
70 const std::vector<SCH_PIN*>& aPins, REPORTER& aReporter );
71
72 void SetModel( int aIndex, std::unique_ptr<SIM_MODEL> aModel );
73
74 std::map<wxString, std::reference_wrapper<const SIM_LIBRARY>> GetLibraries() const;
75 std::vector<std::reference_wrapper<SIM_MODEL>> GetModels() const;
76
77 static wxString ResolveLibraryPath( const wxString& aLibraryPath, const PROJECT* aProject );
78 wxString ResolveEmbeddedLibraryPath( const wxString& aLibPath, const wxString& aRelativeLib );
79
80private:
83 std::map<wxString, std::unique_ptr<SIM_LIBRARY>> m_libraries;
84 std::vector<std::unique_ptr<SIM_MODEL>> m_models;
85};
86
87
88#endif // SIM_LIB_MGR_H
Container for project specific data.
Definition: project.h:62
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:71
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Schematic symbol object.
Definition: sch_symbol.h:108
void SetModel(int aIndex, std::unique_ptr< SIM_MODEL > aModel)
wxString ResolveEmbeddedLibraryPath(const wxString &aLibPath, const wxString &aRelativeLib)
Definition: sim_lib_mgr.cpp:95
const PROJECT * m_project
Definition: sim_lib_mgr.h:81
bool m_forceFullParse
Definition: sim_lib_mgr.h:82
SIM_MODEL & CreateModel(SIM_MODEL::TYPE aType, const std::vector< SCH_PIN * > &aPins, REPORTER &aReporter)
std::vector< std::unique_ptr< SIM_MODEL > > m_models
Definition: sim_lib_mgr.h:84
virtual ~SIM_LIB_MGR()=default
static wxString ResolveLibraryPath(const wxString &aLibraryPath, const PROJECT *aProject)
Definition: sim_lib_mgr.cpp:56
std::map< wxString, std::reference_wrapper< const SIM_LIBRARY > > GetLibraries() const
std::vector< std::reference_wrapper< SIM_MODEL > > GetModels() const
void Clear()
Definition: sim_lib_mgr.cpp:49
void SetLibrary(const wxString &aLibraryPath, REPORTER &aReporter)
void SetForceFullParse()
Definition: sim_lib_mgr.h:44
std::map< wxString, std::unique_ptr< SIM_LIBRARY > > m_libraries
Definition: sim_lib_mgr.h:83