Load.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* libscopehal                                                                                                          *
*                                                                                                                      *
* Copyright (c) 2012-2024 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 Load_h
#define Load_h
 
class Load : public virtual Instrument
{
public:
    Load();
    virtual ~Load();
 
    virtual unsigned int GetInstrumentTypes() const override;
 
    virtual bool AcquireData() override;
 
    //New object model does not have explicit query methods for channel properties.
    //Instead, call AcquireData() then read scalar channel state
 
    // Operating modes
 
    enum LoadMode
    {
        MODE_CONSTANT_CURRENT,
 
        MODE_CONSTANT_VOLTAGE,
 
        MODE_CONSTANT_RESISTANCE,
 
        MODE_CONSTANT_POWER
    };
 
    virtual LoadMode GetLoadMode(size_t channel) =0;
 
    virtual void SetLoadMode(size_t channel, LoadMode mode) =0;
 
    static std::string GetNameOfLoadMode(LoadMode mode);
    static LoadMode GetLoadModeOfName(const std::string& name);
 
    // Range selection
 
    virtual std::vector<float> GetLoadCurrentRanges(size_t channel) =0;
 
    virtual size_t GetLoadCurrentRange(size_t channel) =0;
 
    virtual std::vector<float> GetLoadVoltageRanges(size_t channel) =0;
 
    virtual size_t GetLoadVoltageRange(size_t channel) =0;
 
    virtual void SetLoadVoltageRange(size_t channel, size_t rangeIndex) =0;
 
    virtual void SetLoadCurrentRange(size_t channel, size_t rangeIndex) =0;
 
    // Channel control
 
    virtual bool GetLoadActive(size_t channel) =0;
 
    virtual void SetLoadActive(size_t channel, bool active) =0;
 
    virtual float GetLoadSetPoint(size_t channel) =0;
 
    virtual void SetLoadSetPoint(size_t channel, float target) =0;
 
    // Readback
    // Typically called by AcquireData() and cached in the channel object, not used directly by applications
 
protected:
 
    virtual float GetLoadVoltageActual(size_t channel) =0;
 
    virtual float GetLoadCurrentActual(size_t channel) =0;
 
    // Configuration storage
 
protected:
    void DoSerializeConfiguration(YAML::Node& node, IDTable& table);
    void DoLoadConfiguration(int version, const YAML::Node& node, IDTable& idmap);
    void DoPreLoadConfiguration(int version, const YAML::Node& node, IDTable& idmap, ConfigWarningList& list);
};
 
#endif