simulator.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2022 Sylwester Kocjan <[email protected]>
 * Copyright (C) 2022-2024 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 <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <mutex>
#include <memory>
 
class SPICE_SIMULATOR;
class REPORTER;
 
class SIMULATION_MODEL
{
public:
    virtual ~SIMULATION_MODEL() {};
};
 
 
class SIMULATOR
{
public:
    SIMULATOR() :
        m_simModel( nullptr )
    {}
 
    virtual ~SIMULATOR() {}
 
    static std::shared_ptr<SPICE_SIMULATOR> CreateInstance( const std::string& aName );
 
    /*
     * @return mutex for exclusive access to the simulator.
     */
    std::mutex& GetMutex()
    {
        return m_mutex;
    }
 
    virtual bool Attach( const std::shared_ptr<SIMULATION_MODEL>& aModel,
                         const wxString& aSimCommand, unsigned aSimOptions,
                         const wxString& aInputPath, REPORTER& aReporter )
    {
        m_simModel = aModel;
        return true;
    }
 
    virtual bool Run() = 0;
 
    virtual bool Stop() = 0;
 
    virtual bool IsRunning() = 0;
 
    virtual void Clean() = 0;
 
protected:
    std::shared_ptr<SIMULATION_MODEL> m_simModel;
 
private:
    std::mutex m_mutex;
};