InstrumentChannel.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 InstrumentChannel_h
#define InstrumentChannel_h
 
#include "Stream.h"
 
class Instrument;
 
class InstrumentChannel : public FlowGraphNode
{
public:
    InstrumentChannel(
        Instrument* inst,
        const std::string& hwname,
        const std::string& color = "#808080",
        Unit xunit = Unit(Unit::UNIT_FS),
        size_t index = 0);
 
    InstrumentChannel(
        Instrument* inst,
        const std::string& hwname,
        const std::string& color = "#808080",
        Unit xunit = Unit(Unit::UNIT_FS),
        Unit yunit = Unit(Unit::UNIT_VOLTS),
        Stream::StreamType stype = Stream::STREAM_TYPE_ANALOG,
        size_t index = 0);
 
    virtual ~InstrumentChannel();
 
    std::string m_displaycolor;
 
    virtual void SetDisplayName(std::string name);
    virtual std::string GetDisplayName();
 
    const std::string& GetHwname() const
    { return m_hwname; }
 
    size_t GetIndex() const
    { return m_index; }
 
    Instrument* GetInstrument() const
    { return m_instrument; }
 
    void ClearCachedDisplayName()
    { m_displayname = ""; }
 
    // Connector types
 
    enum PhysicalConnector
    {
        CONNECTOR_BANANA_DUAL,
        CONNECTOR_BMA,
        CONNECTOR_BNC,
        CONNECTOR_K,
        CONNECTOR_K_DUAL,
        CONNECTOR_N,
        CONNECTOR_SMA
    };
 
    virtual PhysicalConnector GetPhysicalConnector();
 
    // Stream management
public:
 
    void SetData(WaveformBase* pNew, size_t stream);
 
    virtual Unit GetXAxisUnits()
    { return m_xAxisUnit; }
 
    virtual Unit GetYAxisUnits(size_t stream)
    {
        if(stream < m_streams.size())
            return m_streams[stream].m_yAxisUnit;
        else
            return Unit(Unit::UNIT_VOLTS);
    }
 
    virtual void SetXAxisUnits(const Unit& rhs)
    { m_xAxisUnit = rhs; }
 
    virtual void SetYAxisUnits(const Unit& rhs, size_t stream)
    { m_streams[stream].m_yAxisUnit = rhs; }
 
    Stream::StreamType GetType(size_t stream)
    {
        if(stream < m_streams.size())
            return m_streams[stream].m_stype;
        else
            return Stream::STREAM_TYPE_UNDEFINED;
    }
 
    size_t GetStreamCount()
    { return m_streams.size(); }
 
    std::string GetStreamName(size_t stream)
    {
        if(stream < m_streams.size())
            return m_streams[stream].m_name;
        else
            return "";
    }
 
    WaveformBase* GetData(size_t stream)
    {
        if(stream >= m_streams.size())
            return nullptr;
        return m_streams[stream].m_waveform;
    }
 
    uint8_t GetStreamFlags(size_t stream)
    {
        if(stream >= m_streams.size())
            return 0;
        return m_streams[stream].m_flags;
    }
 
    float GetScalarValue(size_t stream)
    {
        if(stream >= m_streams.size())
            return 0;
        return m_streams[stream].m_value;
    }
 
    void SetScalarValue(size_t stream, float value)
    {
        if(stream >= m_streams.size())
            return;
        m_streams[stream].m_value = value;
    }
 
    uint64_t GetDigitalScalarValue(size_t stream)
    {
        if(stream >= m_streams.size())
            return 0;
        return m_streams[stream].m_digitalValue;
    }
 
    uint64_t GetDigitalWidth(size_t stream)
    {
        if(stream >= m_streams.size())
            return 0;
        return m_streams[stream].m_digitalValueWidth;
    }
 
    void SetDigitalWidth(size_t stream, uint64_t width)
    {
        if(stream >= m_streams.size())
            return;
        m_streams[stream].m_digitalValueWidth = width;
    }
 
    void SetDigitalScalarValue(size_t stream, uint64_t value)
    {
        if(stream >= m_streams.size())
            return;
        m_streams[stream].m_digitalValue = value;
    }
 
    WaveformBase* Detach(size_t stream)
    {
        WaveformBase* tmp = m_streams[stream].m_waveform;
        m_streams[stream].m_waveform = NULL;
        return tmp;
    }
 
    virtual bool ShouldPersistWaveform();
 
    enum VisibilityMode
    {
        VIS_HIDE,
        VIS_AUTO,   //decide based on whether it's enabled etc
        VIS_SHOW,
    } m_visibilityMode;
 
    enum DownloadState
    {
        DOWNLOAD_UNKNOWN,
        DOWNLOAD_NONE,                  
        DOWNLOAD_WAITING,               
        DOWNLOAD_IN_PROGRESS,               
        DOWNLOAD_FINISHED               
    };
 
    virtual DownloadState GetDownloadState();
 
    virtual float GetDownloadProgress();
 
    virtual double GetDownloadStartTime();
 
    virtual void Refresh(vk::raii::CommandBuffer& cmdBuf, std::shared_ptr<QueueHandle> queue) override;
 
protected:
 
    virtual void ClearStreams();
    virtual size_t AddStream(Unit yunit, const std::string& name, Stream::StreamType stype, uint8_t flags = 0);
 
    Instrument* m_instrument;
 
    std::string m_hwname;
 
    std::string m_displayname;
 
    size_t m_index;
 
    Unit m_xAxisUnit;
 
    std::vector<Stream> m_streams;
};
 
#endif