sim_model_multiunit.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The 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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef SIM_MODEL_MULTIUNIT_H
#define SIM_MODEL_MULTIUNIT_H
 
#include <utility>
#include <vector>
#include <wx/string.h>
 
#include <sim/sim_model_spice.h>
#include <sim/spice_generator.h>
 

struct UNIT_PIN_MAP
{
    int                                        unit = 0;
    std::vector<std::pair<wxString, wxString>> pins;   // symbolPinNumber -> modelPinName
};
 

struct SIM_DECOMPOSITION
{
    enum class MODE
    {
        WHOLE_DEVICE,
        REPEAT_PER_UNIT
    };
 
    MODE                  mode = MODE::WHOLE_DEVICE;
    std::vector<wxString> sharedModelPins;   // model-pin names common to all instances
 
    static SIM_DECOMPOSITION Parse( const wxString& aField );
    wxString                 Format() const;
};
 

std::vector<std::pair<wxString, wxString>> ParseSimPinsTokens( const wxString& aPins,
                                                               const wxString& aRef );
 
 
class SIM_MODEL_MULTIUNIT;
 

class SPICE_GENERATOR_MULTIUNIT : public SPICE_GENERATOR
{
public:
    using SPICE_GENERATOR::SPICE_GENERATOR;
 
    std::string ModelName( const SPICE_ITEM& aItem ) const override;
    std::string ModelLine( const SPICE_ITEM& aItem ) const override;
    std::vector<std::string> CurrentNames( const SPICE_ITEM& aItem ) const override;
 
private:
    const SIM_MODEL_MULTIUNIT& multiunit() const;
};
 

class SIM_MODEL_MULTIUNIT : public SIM_MODEL_SPICE
{
public:
    friend class SPICE_GENERATOR_MULTIUNIT;

    SIM_MODEL_MULTIUNIT( const SIM_MODEL& aBaseModel, const wxString& aBaseModelName,
                         const std::vector<UNIT_PIN_MAP>& aUnitMaps,
                         const std::vector<wxString>& aSharedModelPins );
 
    const wxString& GetSignature() const { return m_signature; }
    int             GetInstanceCount() const { return static_cast<int>( m_instances.size() ); }
 
private:
    struct INSTANCE
    {
        int                   unit = 0;
        std::vector<wxString> nodes;   
    };
 
    wxString computeSignature() const;
 
    wxString              m_baseModelName;   
    wxString              m_signature;       
    std::vector<INSTANCE> m_instances;
};
 
#endif // SIM_MODEL_MULTIUNIT_H