MockPowerSupply.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* libscopehal                                                                                                          *
*                                                                                                                      *
* Copyright (c) 2012-2026 Andrew D. Zonenberg and contributors                                                         *
* All rights reserved.                                                                                                 *
*                                                                                                                      *
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the     *
* following conditions are met:                                                                                        *
*                                                                                                                      *
*    * Redistributions of source code must retain the above copyright notice, this list of conditions, and the         *
*      following disclaimer.                                                                                           *
*                                                                                                                      *
*    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the       *
*      following disclaimer in the documentation and/or other materials provided with the distribution.                *
*                                                                                                                      *
*    * Neither the name of the author nor the names of any contributors may be used to endorse or promote products     *
*      derived from this software without specific prior written permission.                                           *
*                                                                                                                      *
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED   *
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES        *
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR       *
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE       *
* POSSIBILITY OF SUCH DAMAGE.                                                                                          *
*                                                                                                                      *
***********************************************************************************************************************/
 
#ifndef MockPowerSupply_h
#define MockPowerSupply_h
 
class MockPowerSupply : public MockInstrument, public SCPIPowerSupply
{
public:
    MockPowerSupply(
        const std::string& name,
        const std::string& vendor,
        const std::string& serial,
        const std::string& transport,
        const std::string& driver,
        const std::string& args
    );
    virtual ~MockPowerSupply();
 
    //Device capabilities
    bool SupportsSoftStart() override;
    bool SupportsIndividualOutputSwitching() override;
    bool SupportsMasterOutputSwitching() override;
    bool SupportsOvercurrentShutdown() override;
 
    //Read sensors
    double GetPowerVoltageActual(int chan) override;    //actual voltage after current limiting
    double GetPowerVoltageNominal(int chan) override;   //set point
    double GetPowerCurrentActual(int chan) override;    //actual current drawn by the load
    double GetPowerCurrentNominal(int chan) override;   //current limit
    bool GetPowerChannelActive(int chan) override;
 
    //Configuration
    bool GetPowerOvercurrentShutdownEnabled(int chan) override; //shut channel off entirely on overload,
                                                                //rather than current limiting
    void SetPowerOvercurrentShutdownEnabled(int chan, bool enable) override;
    bool GetPowerOvercurrentShutdownTripped(int chan) override;
    void SetPowerVoltage(int chan, double volts) override;
    void SetPowerCurrent(int chan, double amps) override;
    void SetPowerChannelActive(int chan, bool on) override;
    bool IsPowerConstantCurrent(int chan) override;
 
    bool GetMasterPowerEnable() override;
    void SetMasterPowerEnable(bool enable) override;
 
    // Serialization
    //This is intentionally not virtual since it's called by Instrument::m_preloaders
    //cppcheck-suppress duplInheritedMember
    void DoPreLoadConfiguration(int version, const YAML::Node& node, IDTable& idmap, ConfigWarningList& warnings);
 
    // SCPI
    virtual void BackgroundProcessing() override {}
    virtual uint32_t GetInstrumentTypesForChannel(size_t i) const override;
 
 
protected:
 
    bool m_masterEnabled;
    bool m_hasSoftStart;
    bool m_hasIndividualOutputSwitching;
    bool m_hasMasterOutputSwitching;
    bool m_hasOvercurrentShutdown;
    std::map<size_t, bool> m_enabled;
    std::map<size_t, bool> m_constantCurrent;
    std::map<size_t, bool> m_overcurrentShutdown;
    std::map<size_t, bool> m_overcurrentTripped;
    std::map<size_t, double> m_voltagesActual;
    std::map<size_t, double> m_currentsActual;
    std::map<size_t, double> m_voltagesNominal;
    std::map<size_t, double> m_currentsNominal;
    std::map<size_t, double> m_voltageSetPoints;
    std::map<size_t, double> m_currentSetPoints;
 
};
 
#endif