DemoOscilloscope.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 DemoOscilloscope_h
#define DemoOscilloscope_h
 
#include "TestWaveformSource.h"
#include "TestDigitalWaveformSource.h"
#include <random>
 
class DemoOscilloscope : public virtual SCPIOscilloscope
{
public:
    DemoOscilloscope(SCPITransport* transport);
    virtual ~DemoOscilloscope();
 
    //not copyable or assignable
    DemoOscilloscope(const DemoOscilloscope& rhs) =delete;
    DemoOscilloscope& operator=(const DemoOscilloscope& rhs) =delete;
 
    virtual std::string IDPing() override;
 
    virtual std::string GetTransportConnectionString() override;
    virtual std::string GetTransportName() override;
    virtual uint32_t GetInstrumentTypesForChannel(size_t i) const override;
 
    //Channel configuration
    virtual bool IsChannelEnabled(size_t i) override;
    virtual void EnableChannel(size_t i) override;
    virtual void DisableChannel(size_t i) override;
    virtual OscilloscopeChannel::CouplingType GetChannelCoupling(size_t i) override;
    virtual void SetChannelCoupling(size_t i, OscilloscopeChannel::CouplingType type) override;
    virtual std::vector<OscilloscopeChannel::CouplingType> GetAvailableCouplings(size_t i) override;
    virtual double GetChannelAttenuation(size_t i) override;
    virtual void SetChannelAttenuation(size_t i, double atten) override;
    virtual unsigned int GetChannelBandwidthLimit(size_t i) override;
    virtual void SetChannelBandwidthLimit(size_t i, unsigned int limit_mhz) override;
    virtual float GetChannelVoltageRange(size_t i, size_t stream) override;
    virtual void SetChannelVoltageRange(size_t i, size_t stream, float range) override;
    virtual OscilloscopeChannel* GetExternalTrigger() override;
    virtual float GetChannelOffset(size_t i, size_t stream) override;
    virtual void SetChannelOffset(size_t i, size_t stream, float offset) override;
    virtual bool IsHighRateOffsetCapable(size_t i) override;
 
    //Triggering
    virtual Oscilloscope::TriggerMode PollTrigger() override;
    virtual bool AcquireData() override;
    virtual void Start() override;
    virtual void StartSingleTrigger() override;
    virtual void Stop() override;
    virtual void ForceTrigger() override;
    virtual bool IsTriggerArmed() override;
    virtual void PushTrigger() override;
    virtual void PullTrigger() override;
 
    virtual std::vector<uint64_t> GetSampleRatesNonInterleaved() override;
    virtual std::vector<uint64_t> GetSampleRatesInterleaved() override;
    virtual std::set<InterleaveConflict> GetInterleaveConflicts() override;
    virtual std::vector<uint64_t> GetSampleDepthsNonInterleaved() override;
    virtual std::vector<uint64_t> GetSampleDepthsInterleaved() override;
    virtual uint64_t GetSampleRate() override;
    virtual uint64_t GetSampleDepth() override;
    virtual void SetSampleDepth(uint64_t depth) override;
    virtual void SetSampleRate(uint64_t rate) override;
    virtual void SetTriggerOffset(int64_t offset) override;
    virtual int64_t GetTriggerOffset() override;
    virtual bool IsInterleaving() override;
    virtual bool SetInterleaving(bool combine) override;
    virtual bool CanInterleave() override;
 
    virtual bool IsADCModeConfigurable() override;
    virtual bool IsADCModePerChannel() override;
    virtual std::vector<std::string> GetADCModeNames(size_t channel) override;
    virtual size_t GetADCMode(size_t channel) override;
    virtual void SetADCMode(size_t channel, size_t mode) override;
    virtual std::vector<AnalogBank> GetAnalogBanks() override;
    virtual AnalogBank GetAnalogBank(size_t channel) override;
 
    virtual unsigned int GetInstrumentTypes() const override;
    virtual void LoadConfiguration(int version, const YAML::Node& node, IDTable& idmap) override;
 
    virtual std::vector<DigitalBank> GetDigitalBanks() override;
 
 
protected:
 
    OscilloscopeChannel* m_extTrigger;
 
    std::map<size_t, bool> m_channelsEnabled;
 
    std::map<size_t, OscilloscopeChannel::CouplingType> m_channelCoupling;
 
    std::map<size_t, double> m_channelAttenuation;
 
    std::map<size_t, unsigned int> m_channelBandwidth;
 
    std::map<size_t, float> m_channelVoltageRange;
 
    std::map<size_t, float> m_channelOffset;
 
    std::map<size_t, size_t> m_channelModes;
 
    std::vector<OscilloscopeChannel*> m_digitalChannels;
 
    enum ChannelModes
    {
        CHANNEL_MODE_IDEAL,
 
        CHANNEL_MODE_NOISE,
 
        CHANNEL_MODE_NOISE_LPF
    };
 
    float m_sweepFreq;
 
    uint64_t m_depth;
 
    uint64_t m_rate;
 
    std::random_device m_rd;
 
    std::minstd_rand* m_rng[4];
 
    TestWaveformSource* m_source[4];
 
    TestDigitalWaveformSource* m_digitalSource;
 
public:
    static std::string GetDriverNameInternal();
 
    //This is intentionally not virtual since it's a static method used by enumeration
    //cppcheck-suppress duplInheritedMember
    static std::vector<SCPIInstrumentModel> GetDriverSupportedModels()
    {
        return
        {
            {"Demo Oscilloscope", {{ SCPITransportType::TRANSPORT_NULL, "" }}}
        };
    }
    OSCILLOSCOPE_INITPROC(DemoOscilloscope)
};
 
#endif