realAscot/kicad-source
1
0
Fork 0
mirror of https://gitlab.com/kicad/code/kicad.git synced 2025-09-14 18:23:15 +02:00
Code Issues Packages Projects Releases Wiki Activity
kicad-source/eeschema/dialogs/dialog_sim_model.h

109 lines
4.3 KiB
C
Raw Normal View History

Spice model editor dialog
2016-08-11 14:41:40 +02:00
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
Begin development of a new Sim Model Editor dialog With that also begin reworking the internal structure of the simulation model storage. Some models have parameter information extracted from Ngspice, which was specially patched to faciliate that. The model is stored and managed by the SPICE_MODEL class (later will be renamed to SIM_MODEL).
2022-02-09 01:45:04 +01:00
* Copyright (C) 2022 Mikolaj Wielgus
* Copyright (C) 2022 KiCad Developers, see AUTHORS.txt for contributors.
Spice model editor dialog
2016-08-11 14:41:40 +02:00
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
Changed the simulator code license to GPLv3+
2016-08-11 14:41:43 +02:00
* as published by the Free Software Foundation; either version 3
Spice model editor dialog
2016-08-11 14:41:40 +02:00
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you may find one here:
Changed the simulator code license to GPLv3+
2016-08-11 14:41:43 +02:00
* https://www.gnu.org/licenses/gpl-3.0.html
* or you may search the http://www.gnu.org website for the version 3 license,
Spice model editor dialog
2016-08-11 14:41:40 +02:00
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef DIALOG_SPICE_MODEL_H
#define DIALOG_SPICE_MODEL_H
Sim: Spice netlist exporter rewrite Rewrite the spice exporter to work with the new simulation model architecture and data model, with many bugfixes related to the latter two along the way.
2022-04-12 16:37:06 +02:00
#include <dialog_sim_model_base.h>
#include <netlist_exporter_spice.h>
Dark theme support for SPICE model editor
2021-12-03 03:41:02 +01:00
#include <scintilla_tricks.h>
Validators for Spice model dialog
2016-08-11 14:41:56 +02:00
Sim Model Editor: Display model parameters This commit adds parameter display functionality, via a wxPropertyGrid widget, to the Sim Model Editor. To faciliate that, a SIM_VALUE class is created to serialize, deserialize, and validate numeric values in the new parameter grid. SPICE_MODEL is renamed to SIM_MODEL and split into several subclasses that correspond to different model kinds.
2022-02-21 04:58:31 +01:00
#include <sim/sim_model.h>
Sim: Implement loading Spice library files Implement parsing and loading Spice libraries into KiCad. This is done without any involvement of Ngspice -- we create our own in-tree parser using PEGTL -- because Ngspice doesn't offer any intermediate output we could plug ourselves into. We don't parse everything -- just the library content, so this won't be that much effort. We implement some basic Spice code preview to give the user a hint what Spice code eir model will correspond to.
2022-04-01 06:30:50 +02:00
#include <sim/sim_library.h>
Eeschema: use symbol nomenclature for object file naming.
2021-02-24 08:48:02 -05:00
#include <sch_symbol.h>
Validators for Spice model dialog
2016-08-11 14:41:56 +02:00
Sim Model Editor: Display model parameters This commit adds parameter display functionality, via a wxPropertyGrid widget, to the Sim Model Editor. To faciliate that, a SIM_VALUE class is created to serialize, deserialize, and validate numeric values in the new parameter grid. SPICE_MODEL is renamed to SIM_MODEL and split into several subclasses that correspond to different model kinds.
2022-02-21 04:58:31 +01:00
// Some probable wxWidgets bugs encountered when writing this class:
// 1. There are rendering problems with wxPropertyGrid on Linux, GTK, Xorg when
// wxPG_NATIVE_DOUBLE_BUFFERING flag is not set.
// 2. wxPropertyGridManager->ShowHeader() segfaults when called from this dialog's constructor.
Begin development of a new Sim Model Editor dialog With that also begin reworking the internal structure of the simulation model storage. Some models have parameter information extracted from Ngspice, which was specially patched to faciliate that. The model is stored and managed by the SPICE_MODEL class (later will be renamed to SIM_MODEL).
2022-02-09 01:45:04 +01:00
template <typename T>
Sim: Spice netlist exporter rewrite Rewrite the spice exporter to work with the new simulation model architecture and data model, with many bugfixes related to the latter two along the way.
2022-04-12 16:37:06 +02:00
class DIALOG_SIM_MODEL : public DIALOG_SIM_MODEL_BASE
Spice model editor dialog
2016-08-11 14:41:40 +02:00
{
public:
Sim Model Editor: Serialize models in fields Implemented serialization and deserialization of models in symbol fields through the SIM_VALUE class. We don't carry the Spice legacy of case-insensitive suffixes, instead we conform to the SI standard (i.e. M is Mega, not milli, P is peta, p is pico). Parameter grid value validation is implemented by simply not allowing any characters that will make the value invalid (instead of highlighting the field in a red color). This will likely be changed at some point in the future.
2022-03-09 02:40:59 +01:00
enum class PARAM_COLUMN : int { DESCRIPTION, VALUE, UNIT, DEFAULT, TYPE, END_ };
enum class PIN_COLUMN : int { SYMBOL, MODEL };
Begin development of a new Sim Model Editor dialog With that also begin reworking the internal structure of the simulation model storage. Some models have parameter information extracted from Ngspice, which was specially patched to faciliate that. The model is stored and managed by the SPICE_MODEL class (later will be renamed to SIM_MODEL).
2022-02-09 01:45:04 +01:00
Sim: Spice netlist exporter rewrite Rewrite the spice exporter to work with the new simulation model architecture and data model, with many bugfixes related to the latter two along the way.
2022-04-12 16:37:06 +02:00
DIALOG_SIM_MODEL( wxWindow* aParent, SCH_SYMBOL& aSymbol, std::vector<T>& aSchFields );
Spice model editor dialog
2016-08-11 14:41:40 +02:00
private:
Begin development of a new Sim Model Editor dialog With that also begin reworking the internal structure of the simulation model storage. Some models have parameter information extracted from Ngspice, which was specially patched to faciliate that. The model is stored and managed by the SPICE_MODEL class (later will be renamed to SIM_MODEL).
2022-02-09 01:45:04 +01:00
bool TransferDataToWindow() override;
Sim: Implement loading Spice library files Implement parsing and loading Spice libraries into KiCad. This is done without any involvement of Ngspice -- we create our own in-tree parser using PEGTL -- because Ngspice doesn't offer any intermediate output we could plug ourselves into. We don't parse everything -- just the library content, so this won't be that much effort. We implement some basic Spice code preview to give the user a hint what Spice code eir model will correspond to.
2022-04-01 06:30:50 +02:00
bool TransferDataFromWindow() override;
Spice model editor dialog
2016-08-11 14:41:40 +02:00
Begin development of a new Sim Model Editor dialog With that also begin reworking the internal structure of the simulation model storage. Some models have parameter information extracted from Ngspice, which was specially patched to faciliate that. The model is stored and managed by the SPICE_MODEL class (later will be renamed to SIM_MODEL).
2022-02-09 01:45:04 +01:00
void updateWidgets();
Sim Model Editor: Serialize models in fields Implemented serialization and deserialization of models in symbol fields through the SIM_VALUE class. We don't carry the Spice legacy of case-insensitive suffixes, instead we conform to the SI standard (i.e. M is Mega, not milli, P is peta, p is pico). Parameter grid value validation is implemented by simply not allowing any characters that will make the value invalid (instead of highlighting the field in a red color). This will likely be changed at some point in the future.
2022-03-09 02:40:59 +01:00
void updateModelParamsTab();
void updateModelCodeTab();
void updatePinAssignmentsTab();
void updatePinAssignmentsGridEditors();
Sim: Implement loading Spice library files Implement parsing and loading Spice libraries into KiCad. This is done without any involvement of Ngspice -- we create our own in-tree parser using PEGTL -- because Ngspice doesn't offer any intermediate output we could plug ourselves into. We don't parse everything -- just the library content, so this won't be that much effort. We implement some basic Spice code preview to give the user a hint what Spice code eir model will correspond to.
2022-04-01 06:30:50 +02:00
void loadLibrary( const wxString& aFilePath );
Sim Model Editor: Display model parameters This commit adds parameter display functionality, via a wxPropertyGrid widget, to the Sim Model Editor. To faciliate that, a SIM_VALUE class is created to serialize, deserialize, and validate numeric values in the new parameter grid. SPICE_MODEL is renamed to SIM_MODEL and split into several subclasses that correspond to different model kinds.
2022-02-21 04:58:31 +01:00
Sim: Implement loading Spice library files Implement parsing and loading Spice libraries into KiCad. This is done without any involvement of Ngspice -- we create our own in-tree parser using PEGTL -- because Ngspice doesn't offer any intermediate output we could plug ourselves into. We don't parse everything -- just the library content, so this won't be that much effort. We implement some basic Spice code preview to give the user a hint what Spice code eir model will correspond to.
2022-04-01 06:30:50 +02:00
void addParamPropertyIfRelevant( int aParamIndex );
wxPGProperty* newParamProperty( int aParamIndex ) const;
SIM_MODEL& curModel() const;
std::shared_ptr<SIM_MODEL> curModelSharedPtr() const;
Spice model editor dialog
2016-08-11 14:41:40 +02:00
Sim Model Editor: Serialize models in fields Implemented serialization and deserialization of models in symbol fields through the SIM_VALUE class. We don't carry the Spice legacy of case-insensitive suffixes, instead we conform to the SI standard (i.e. M is Mega, not milli, P is peta, p is pico). Parameter grid value validation is implemented by simply not allowing any characters that will make the value invalid (instead of highlighting the field in a red color). This will likely be changed at some point in the future.
2022-03-09 02:40:59 +01:00
wxString getSymbolPinString( int aSymbolPinNumber ) const;
wxString getModelPinString( int aModelPinNumber ) const;
int getModelPinNumber( const wxString& aModelPinString ) const;
Sim: Implement loading Spice library files Implement parsing and loading Spice libraries into KiCad. This is done without any involvement of Ngspice -- we create our own in-tree parser using PEGTL -- because Ngspice doesn't offer any intermediate output we could plug ourselves into. We don't parse everything -- just the library content, so this won't be that much effort. We implement some basic Spice code preview to give the user a hint what Spice code eir model will correspond to.
2022-04-01 06:30:50 +02:00
void onRadioButton( wxCommandEvent& aEvent ) override;
void onBrowseButtonClick( wxCommandEvent& aEvent ) override;
void onModelNameCombobox( wxCommandEvent& aEvent ) override;
void onOverrideCheckbox( wxCommandEvent& aEvent ) override;
Sim Model Editor: Serialize models in fields Implemented serialization and deserialization of models in symbol fields through the SIM_VALUE class. We don't carry the Spice legacy of case-insensitive suffixes, instead we conform to the SI standard (i.e. M is Mega, not milli, P is peta, p is pico). Parameter grid value validation is implemented by simply not allowing any characters that will make the value invalid (instead of highlighting the field in a red color). This will likely be changed at some point in the future.
2022-03-09 02:40:59 +01:00
void onDeviceTypeChoice( wxCommandEvent& aEvent ) override;
void onTypeChoice( wxCommandEvent& aEvent ) override;
Sim: Implement loading Spice library files Implement parsing and loading Spice libraries into KiCad. This is done without any involvement of Ngspice -- we create our own in-tree parser using PEGTL -- because Ngspice doesn't offer any intermediate output we could plug ourselves into. We don't parse everything -- just the library content, so this won't be that much effort. We implement some basic Spice code preview to give the user a hint what Spice code eir model will correspond to.
2022-04-01 06:30:50 +02:00
void onParamGridChanged( wxPropertyGridEvent& aEvent ) override;
Sim Model Editor: Serialize models in fields Implemented serialization and deserialization of models in symbol fields through the SIM_VALUE class. We don't carry the Spice legacy of case-insensitive suffixes, instead we conform to the SI standard (i.e. M is Mega, not milli, P is peta, p is pico). Parameter grid value validation is implemented by simply not allowing any characters that will make the value invalid (instead of highlighting the field in a red color). This will likely be changed at some point in the future.
2022-03-09 02:40:59 +01:00
void onPinAssignmentsGridCellChange( wxGridEvent& aEvent ) override;
void onPinAssignmentsGridSize( wxSizeEvent& aEvent ) override;
Sim: Implement loading Spice library files Implement parsing and loading Spice libraries into KiCad. This is done without any involvement of Ngspice -- we create our own in-tree parser using PEGTL -- because Ngspice doesn't offer any intermediate output we could plug ourselves into. We don't parse everything -- just the library content, so this won't be that much effort. We implement some basic Spice code preview to give the user a hint what Spice code eir model will correspond to.
2022-04-01 06:30:50 +02:00
void onLibraryFilenameInputUpdate( wxUpdateUIEvent& aEvent ) override;
void onBrowseButtonUpdate( wxUpdateUIEvent& aEvent ) override;
void onModelNameComboboxUpdate( wxUpdateUIEvent& aEvent ) override;
void onOverrideCheckboxUpdate( wxUpdateUIEvent& aEvent ) override;
void onDeviceTypeChoiceUpdate( wxUpdateUIEvent& aEvent ) override;
void onTypeChoiceUpdate( wxUpdateUIEvent& aEvent ) override;
Sim Model Editor: Serialize models in fields Implemented serialization and deserialization of models in symbol fields through the SIM_VALUE class. We don't carry the Spice legacy of case-insensitive suffixes, instead we conform to the SI standard (i.e. M is Mega, not milli, P is peta, p is pico). Parameter grid value validation is implemented by simply not allowing any characters that will make the value invalid (instead of highlighting the field in a red color). This will likely be changed at some point in the future.
2022-03-09 02:40:59 +01:00
virtual void onSelectionChange( wxPropertyGridEvent& aEvent );
//void onPropertyChanged( wxPropertyGridEvent& aEvent ) override;
Sim: Implement loading Spice library files Implement parsing and loading Spice libraries into KiCad. This is done without any involvement of Ngspice -- we create our own in-tree parser using PEGTL -- because Ngspice doesn't offer any intermediate output we could plug ourselves into. We don't parse everything -- just the library content, so this won't be that much effort. We implement some basic Spice code preview to give the user a hint what Spice code eir model will correspond to.
2022-04-01 06:30:50 +02:00
Rename SCH_COMPONENT to SCH_SYMBOL.
2021-06-10 10:10:55 -04:00
SCH_SYMBOL& m_symbol;
Sim Model Editor: Display model parameters This commit adds parameter display functionality, via a wxPropertyGrid widget, to the Sim Model Editor. To faciliate that, a SIM_VALUE class is created to serialize, deserialize, and validate numeric values in the new parameter grid. SPICE_MODEL is renamed to SIM_MODEL and split into several subclasses that correspond to different model kinds.
2022-02-21 04:58:31 +01:00
std::vector<T>& m_fields;
Spice model editor dialog
2016-08-11 14:41:40 +02:00
Sim: Implement loading Spice library files Implement parsing and loading Spice libraries into KiCad. This is done without any involvement of Ngspice -- we create our own in-tree parser using PEGTL -- because Ngspice doesn't offer any intermediate output we could plug ourselves into. We don't parse everything -- just the library content, so this won't be that much effort. We implement some basic Spice code preview to give the user a hint what Spice code eir model will correspond to.
2022-04-01 06:30:50 +02:00
std::vector<std::shared_ptr<SIM_MODEL>> m_models;
Sim Model Editor: Display model parameters This commit adds parameter display functionality, via a wxPropertyGrid widget, to the Sim Model Editor. To faciliate that, a SIM_VALUE class is created to serialize, deserialize, and validate numeric values in the new parameter grid. SPICE_MODEL is renamed to SIM_MODEL and split into several subclasses that correspond to different model kinds.
2022-02-21 04:58:31 +01:00
std::map<SIM_MODEL::DEVICE_TYPE, SIM_MODEL::TYPE> m_curModelTypeOfDeviceType;
SIM_MODEL::TYPE m_curModelType = SIM_MODEL::TYPE::NONE;
Dark theme support for SPICE model editor
2021-12-03 03:41:02 +01:00
Sim: Implement loading Spice library files Implement parsing and loading Spice libraries into KiCad. This is done without any involvement of Ngspice -- we create our own in-tree parser using PEGTL -- because Ngspice doesn't offer any intermediate output we could plug ourselves into. We don't parse everything -- just the library content, so this won't be that much effort. We implement some basic Spice code preview to give the user a hint what Spice code eir model will correspond to.
2022-04-01 06:30:50 +02:00
std::shared_ptr<SIM_LIBRARY> m_library;
std::vector<std::shared_ptr<SIM_MODEL>> m_libraryModels;
const SIM_MODEL* m_prevModel;
Sim Model Editor: Display model parameters This commit adds parameter display functionality, via a wxPropertyGrid widget, to the Sim Model Editor. To faciliate that, a SIM_VALUE class is created to serialize, deserialize, and validate numeric values in the new parameter grid. SPICE_MODEL is renamed to SIM_MODEL and split into several subclasses that correspond to different model kinds.
2022-02-21 04:58:31 +01:00
wxPGProperty* m_firstCategory; // Used to add principal parameters to root (any better ideas?)
Dark theme support for SPICE model editor
2021-12-03 03:41:02 +01:00
std::unique_ptr<SCINTILLA_TRICKS> m_scintillaTricks;
Spice model editor dialog
2016-08-11 14:41:40 +02:00
};
#endif /* DIALOG_SPICE_MODEL_H */
Reference in New Issue Copy Permalink