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 The 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#pragma once
26
27#include <map>
28#include <vector>
29
30#include <sim/sim_library.h>
31#include <sim/sim_model.h>
32
33class EMBEDDED_FILES;
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 SetFilesStack( std::vector<EMBEDDED_FILES*> aFilesStack )
49 {
50 m_embeddedFilesStack = std::move( aFilesStack );
51 }
52
53 void SetLibrary( const wxString& aLibraryPath, REPORTER& aReporter );
54
55 SIM_MODEL& CreateModel( SIM_MODEL::TYPE aType, const std::vector<SCH_PIN*>& aPins,
56 REPORTER& aReporter );
57
58 SIM_MODEL& CreateModel( const SIM_MODEL* aBaseModel, const std::vector<SCH_PIN*>& aPins,
59 REPORTER& aReporter );
60
61 SIM_MODEL& CreateModel( const SIM_MODEL* aBaseModel, const std::vector<SCH_PIN*>& aPins,
62 const std::vector<SCH_FIELD>& aFields, bool aResolve, int aDepth,
63 REPORTER& aReporter );
64
65 // TODO: The argument can be made const.
66 SIM_LIBRARY::MODEL CreateModel( const SCH_SHEET_PATH* aSheetPath, SCH_SYMBOL& aSymbol,
67 bool aResolve, int aDepth, REPORTER& aReporter );
68
69 SIM_LIBRARY::MODEL CreateModel( const std::vector<SCH_FIELD>& aFields, bool aResolve, int aDepth,
70 const std::vector<SCH_PIN*>& aPins, REPORTER& aReporter );
71
72 SIM_LIBRARY::MODEL CreateModel( const wxString& aLibraryPath, const std::string& aBaseModelName,
73 const std::vector<SCH_FIELD>& aFields, bool aResolve, int aDepth,
74 const std::vector<SCH_PIN*>& aPins, REPORTER& aReporter );
75
76 void SetModel( int aIndex, std::unique_ptr<SIM_MODEL> aModel );
77
78 std::map<wxString, std::reference_wrapper<const SIM_LIBRARY>> GetLibraries() const;
79 std::vector<std::reference_wrapper<SIM_MODEL>> GetModels() const;
80
81 wxString ResolveLibraryPath( const wxString& aLibraryPath, REPORTER& aReporter );
82 wxString ResolveEmbeddedLibraryPath( const wxString& aLibPath, const wxString& aRelativeLib,
83 REPORTER& aReporter );
84
85private:
86 std::vector<EMBEDDED_FILES*> m_embeddedFilesStack; // no ownership
87 const PROJECT* m_project; // no ownership
89 std::map<wxString, std::unique_ptr<SIM_LIBRARY>> m_libraries;
90 std::vector<std::unique_ptr<SIM_MODEL>> m_models;
91};
92
Container for project specific data.
Definition: project.h:65
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:73
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:75
void SetModel(int aIndex, std::unique_ptr< SIM_MODEL > aModel)
wxString ResolveLibraryPath(const wxString &aLibraryPath, REPORTER &aReporter)
Definition: sim_lib_mgr.cpp:58
const PROJECT * m_project
Definition: sim_lib_mgr.h:87
std::vector< EMBEDDED_FILES * > m_embeddedFilesStack
Definition: sim_lib_mgr.h:86
bool m_forceFullParse
Definition: sim_lib_mgr.h:88
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:90
virtual ~SIM_LIB_MGR()=default
std::map< wxString, std::reference_wrapper< const SIM_LIBRARY > > GetLibraries() const
wxString ResolveEmbeddedLibraryPath(const wxString &aLibPath, const wxString &aRelativeLib, REPORTER &aReporter)
std::vector< std::reference_wrapper< SIM_MODEL > > GetModels() const
void Clear()
Definition: sim_lib_mgr.cpp:51
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:89
void SetFilesStack(std::vector< EMBEDDED_FILES * > aFilesStack)
Definition: sim_lib_mgr.h:48