kicad/eeschema/sim/sim_model_spice_fallback.cpp

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2022-2023 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 <sim/sim_model_spice_fallback.h>
#include <fmt/format.h>
#include <boost/algorithm/string/case_conv.hpp>


SIM_MODEL_SPICE_FALLBACK::SIM_MODEL_SPICE_FALLBACK( TYPE aType, const std::string& aRawSpiceCode ) :
        SIM_MODEL_SPICE( aType, std::make_unique<SPICE_GENERATOR_SPICE>( *this ) )
{
    // Create the model we *should* have had to copy its parameter list
    std::unique_ptr<SIM_MODEL> model = SIM_MODEL::Create( aType );

    for( const SIM_MODEL::PARAM& param : model->GetParams() )
        AddParam( param.info );

    m_spiceCode = aRawSpiceCode;
}


void SIM_MODEL_SPICE_FALLBACK::SetPinSymbolPinNumber( const std::string& aPinName,
                                                      const std::string& aSymbolPinNumber )
{
    try
    {
        SIM_MODEL::SetPinSymbolPinNumber( aPinName, aSymbolPinNumber );
    }
    catch( IO_ERROR& )
    {
        // This is a fall-back, so we won't necessarily know the pin names.  If we didn't find
        // it, then just create a new pin.
        m_pins.push_back( { aPinName, aSymbolPinNumber } );
    }
}


std::vector<std::string> SIM_MODEL_SPICE_FALLBACK::GetPinNames() const
{
    // If we're a fall-back for a paticular model type, then return its pin names
    std::unique_ptr<SIM_MODEL> model = SIM_MODEL::Create( GetType() );
    return model->GetPinNames();
}


int SIM_MODEL_SPICE_FALLBACK::doFindParam( const std::string& aParamName ) const
{
    // Special case to allow escaped model parameters (suffixed with "_")

    std::string lowerParamName = boost::to_lower_copy( aParamName );

    std::vector<std::reference_wrapper<const PARAM>> params = GetParams();

    for( int ii = 0; ii < (int) params.size(); ++ii )
    {
        const PARAM& param = params[ii];

        if( param.info.name == lowerParamName || param.info.name == lowerParamName + "_" )
            return ii;
    }

    return -1;
}