Stream.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 Stream_h
#define Stream_h
 
#include "Waveform.h"
 
class Stream
{
public:
 
    enum StreamType
    {
        //Conventional time-series waveforms (or similar graphs like a FFT)
        STREAM_TYPE_ANALOG,
        STREAM_TYPE_DIGITAL,
        STREAM_TYPE_DIGITAL_BUS,
 
        //2D density plots
        STREAM_TYPE_EYE,
        STREAM_TYPE_SPECTROGRAM,
        STREAM_TYPE_WATERFALL,
        STREAM_TYPE_CONSTELLATION,
 
        //Special channels not used for display
        STREAM_TYPE_TRIGGER,    //external trigger input, doesn't have data capture
 
        //Class datatype from a protocol decoder
        STREAM_TYPE_PROTOCOL,
 
        //Single analog value
        STREAM_TYPE_ANALOG_SCALAR,
 
        //Single digital value
        STREAM_TYPE_DIGITAL_SCALAR,
 
        //Other / unspecified
        STREAM_TYPE_UNDEFINED
    };
 
    Stream()
        : m_yAxisUnit(Unit::UNIT_VOLTS)
        , m_name("stream")
        , m_waveform(nullptr)
        , m_value(0)
        , m_digitalValue(0)
        , m_digitalValueWidth(0)
        , m_stype(Stream::STREAM_TYPE_ANALOG)
        , m_flags(0)
    {}
 
    Stream(Unit yunit, std::string name, StreamType type, uint8_t flags = 0)
        : m_yAxisUnit(yunit)
        , m_name(name)
        , m_waveform(nullptr)
        , m_value(0)
        , m_digitalValue(0)
        , m_digitalValueWidth(0)
        , m_stype(type)
        , m_flags(flags)
    {}
 
    Unit m_yAxisUnit;
 
    std::string m_name;
 
    WaveformBase* m_waveform;
 
    double m_value;
 
    uint64_t m_digitalValue;
 
    size_t m_digitalValueWidth;
 
    StreamType m_stype;
 
 
    uint8_t m_flags;
 
    enum
    {
        STREAM_DO_NOT_INTERPOLATE   = 1,
        STREAM_FILL_UNDER           = 2,
        STREAM_INFREQUENTLY_USED    = 4
    };
};
 
#endif