mirror of
https://gitlab.com/kicad/code/kicad.git
synced 2025-09-15 02:33:15 +02:00
38906397d2
Also moves passive RLC inference out from migration to just-in-time creation for the simulator or netlisting. Also fixes a version guard mismatch because the spice migration was done inside UpdateSymbolInstances (which has its own version guard). Also changed UpdateSymbolInstances to UpdateSymbolInstanceData so someone else in the future doesn't think it's a general-purpose symbol instance updater.
226 lines
7.8 KiB
C++
226 lines
7.8 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2022 Mikolaj Wielgus
|
|
* Copyright (C) 2022 KiCad Developers, see AUTHORS.txt for contributors.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 3
|
|
* 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:
|
|
* https://www.gnu.org/licenses/gpl-3.0.html
|
|
* or you may search the http://www.gnu.org website for the version 3 license,
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
*/
|
|
|
|
#include <pgm_base.h>
|
|
#include <string>
|
|
#include <sch_symbol.h>
|
|
|
|
// Include simulator headers after wxWidgets headers to avoid conflicts with Windows headers
|
|
// (especially on msys2 + wxWidgets 3.0.x)
|
|
#include <sim/sim_lib_mgr.h>
|
|
#include <sim/sim_library.h>
|
|
#include <sim/sim_model.h>
|
|
#include <sim/sim_model_ideal.h>
|
|
|
|
|
|
SIM_LIB_MGR::SIM_LIB_MGR( const PROJECT& aPrj ) : m_project( aPrj )
|
|
{
|
|
}
|
|
|
|
|
|
void SIM_LIB_MGR::Clear()
|
|
{
|
|
m_libraries.clear();
|
|
m_models.clear();
|
|
}
|
|
|
|
|
|
SIM_LIBRARY& SIM_LIB_MGR::CreateLibrary( const std::string& aLibraryPath, REPORTER* aReporter )
|
|
{
|
|
std::string absolutePath = std::string( m_project.AbsolutePath( aLibraryPath ).ToUTF8() );
|
|
|
|
auto it =
|
|
m_libraries.try_emplace( aLibraryPath, SIM_LIBRARY::Create( absolutePath, aReporter ) )
|
|
.first;
|
|
return *it->second;
|
|
}
|
|
|
|
SIM_LIBRARY& SIM_LIB_MGR::SetLibrary( const std::string& aLibraryPath, REPORTER* aReporter )
|
|
{
|
|
std::string absolutePath = std::string( m_project.AbsolutePath( aLibraryPath ).ToUTF8() );
|
|
|
|
// May throw an exception.
|
|
std::unique_ptr<SIM_LIBRARY> library = SIM_LIBRARY::Create( absolutePath, aReporter );
|
|
|
|
Clear();
|
|
m_libraries[aLibraryPath] = std::move( library );
|
|
return *m_libraries.at( aLibraryPath );
|
|
}
|
|
|
|
|
|
SIM_MODEL& SIM_LIB_MGR::CreateModel( SIM_MODEL::TYPE aType, int aSymbolPinCount )
|
|
{
|
|
m_models.push_back( SIM_MODEL::Create( aType, aSymbolPinCount ) );
|
|
return *m_models.back();
|
|
}
|
|
|
|
|
|
SIM_MODEL& SIM_LIB_MGR::CreateModel( const SIM_MODEL& aBaseModel, int aSymbolPinCount )
|
|
{
|
|
m_models.push_back( SIM_MODEL::Create( aBaseModel, aSymbolPinCount ) );
|
|
return *m_models.back();
|
|
}
|
|
|
|
|
|
template <typename T>
|
|
SIM_MODEL& SIM_LIB_MGR::CreateModel( const SIM_MODEL& aBaseModel, int aSymbolPinCount,
|
|
const std::vector<T>& aFields )
|
|
{
|
|
m_models.push_back( SIM_MODEL::Create( aBaseModel, aSymbolPinCount, aFields ) );
|
|
return *m_models.back();
|
|
}
|
|
|
|
template SIM_MODEL& SIM_LIB_MGR::CreateModel( const SIM_MODEL& aBaseModel, int aSymbolPinCount,
|
|
const std::vector<SCH_FIELD>& aFields );
|
|
template SIM_MODEL& SIM_LIB_MGR::CreateModel( const SIM_MODEL& aBaseModel, int aSymbolPinCount,
|
|
const std::vector<LIB_FIELD>& aFields );
|
|
|
|
|
|
SIM_LIBRARY::MODEL SIM_LIB_MGR::CreateModel( const SCH_SHEET_PATH* aSheetPath, SCH_SYMBOL& aSymbol )
|
|
{
|
|
std::vector<SCH_FIELD> fields;
|
|
|
|
for( int i = 0; i < aSymbol.GetFieldCount(); ++i )
|
|
{
|
|
fields.emplace_back( VECTOR2I(), i, &aSymbol, aSymbol.GetFields()[ i ].GetName() );
|
|
|
|
if( i == REFERENCE_FIELD )
|
|
fields.back().SetText( aSymbol.GetRef( aSheetPath ) );
|
|
else
|
|
fields.back().SetText( aSymbol.GetFields()[ i ].GetShownText( 0, false ) );
|
|
}
|
|
|
|
// Infer RLC passive models if they aren't specified
|
|
if( !aSymbol.FindField( SIM_MODEL::DEVICE_TYPE_FIELD, false )
|
|
&& !aSymbol.FindField( SIM_MODEL::PARAMS_FIELD, false ) )
|
|
{
|
|
wxString simParams = SIM_MODEL_IDEAL::InferSimParams( aSymbol.GetPrefix(),
|
|
aSymbol.GetValueFieldText( true ) );
|
|
|
|
if( !simParams.IsEmpty() )
|
|
{
|
|
fields.emplace_back( VECTOR2I(), -1, &aSymbol, SIM_MODEL::DEVICE_TYPE_FIELD );
|
|
fields.back().SetText( aSymbol.GetPrefix() );
|
|
|
|
fields.emplace_back( VECTOR2I(), -1, &aSymbol, SIM_MODEL::PARAMS_FIELD );
|
|
fields.back().SetText( simParams );
|
|
}
|
|
}
|
|
|
|
return CreateModel( fields, static_cast<int>( aSymbol.GetRawPins().size() ) );
|
|
}
|
|
|
|
template <typename T>
|
|
SIM_LIBRARY::MODEL SIM_LIB_MGR::CreateModel( const std::vector<T>& aFields, int aSymbolPinCount )
|
|
{
|
|
std::string libraryPath = SIM_MODEL::GetFieldValue( &aFields, SIM_LIBRARY::LIBRARY_FIELD );
|
|
std::string baseModelName = SIM_MODEL::GetFieldValue( &aFields, SIM_LIBRARY::NAME_FIELD );
|
|
|
|
if( libraryPath != "" )
|
|
return CreateModel( libraryPath, baseModelName, aFields, aSymbolPinCount );
|
|
else
|
|
{
|
|
m_models.push_back( SIM_MODEL::Create( aSymbolPinCount, aFields ) );
|
|
return { baseModelName, *m_models.back() };
|
|
}
|
|
}
|
|
|
|
template SIM_LIBRARY::MODEL SIM_LIB_MGR::CreateModel( const std::vector<SCH_FIELD>& aFields,
|
|
int aSymbolPinCount );
|
|
template SIM_LIBRARY::MODEL SIM_LIB_MGR::CreateModel( const std::vector<LIB_FIELD>& aFields,
|
|
int aSymbolPinCount );
|
|
|
|
|
|
template <typename T>
|
|
SIM_LIBRARY::MODEL SIM_LIB_MGR::CreateModel( const std::string& aLibraryPath,
|
|
const std::string& aBaseModelName,
|
|
const std::vector<T>& aFields,
|
|
int aSymbolPinCount )
|
|
{
|
|
std::string absolutePath = std::string( m_project.AbsolutePath( aLibraryPath ).ToUTF8() );
|
|
SIM_LIBRARY* library = nullptr;
|
|
|
|
try
|
|
{
|
|
auto it = m_libraries.try_emplace( aLibraryPath,
|
|
SIM_LIBRARY::Create( absolutePath ) ).first;
|
|
library = &*it->second;
|
|
}
|
|
catch( const IO_ERROR& e )
|
|
{
|
|
THROW_IO_ERROR(
|
|
wxString::Format( _( "Error loading simulation model library '%s': %s" ),
|
|
absolutePath,
|
|
e.What() ) );
|
|
}
|
|
|
|
if( aBaseModelName == "" )
|
|
{
|
|
THROW_IO_ERROR( wxString::Format( _( "Error loading simulation model: no '%s' field" ),
|
|
SIM_LIBRARY::NAME_FIELD ) );
|
|
}
|
|
|
|
SIM_MODEL* baseModel = library->FindModel( aBaseModelName );
|
|
|
|
if( !baseModel )
|
|
{
|
|
THROW_IO_ERROR( wxString::Format( _( "Error loading simulation model: could not find "
|
|
"base model '%s' in library '%s'" ),
|
|
aBaseModelName,
|
|
absolutePath ) );
|
|
}
|
|
|
|
m_models.push_back( SIM_MODEL::Create( *baseModel, aSymbolPinCount, aFields ) );
|
|
|
|
return { aBaseModelName, *m_models.back() };
|
|
}
|
|
|
|
|
|
void SIM_LIB_MGR::SetModel( int aIndex, std::unique_ptr<SIM_MODEL> aModel )
|
|
{
|
|
m_models.at( aIndex ) = std::move( aModel );
|
|
}
|
|
|
|
|
|
std::map<std::string, std::reference_wrapper<const SIM_LIBRARY>> SIM_LIB_MGR::GetLibraries() const
|
|
{
|
|
std::map<std::string, std::reference_wrapper<const SIM_LIBRARY>> libraries;
|
|
|
|
for( auto& [path, library] : m_libraries )
|
|
libraries.try_emplace( path, *library );
|
|
|
|
return libraries;
|
|
}
|
|
|
|
|
|
std::vector<std::reference_wrapper<SIM_MODEL>> SIM_LIB_MGR::GetModels() const
|
|
{
|
|
std::vector<std::reference_wrapper<SIM_MODEL>> models;
|
|
|
|
for( const std::unique_ptr<SIM_MODEL>& model : m_models )
|
|
models.emplace_back( *model );
|
|
|
|
return models;
|
|
}
|