FlowGraphNode.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* libscopehal                                                                                                          *
*                                                                                                                      *
* Copyright (c) 2012-2025 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 FlowGraphNode_h
#define FlowGraphNode_h
 
class OscilloscopeChannel;
class WaveformBase;
class StreamDescriptor;
 
#include "FilterParameter.h"
#include "Waveform.h"
#include "Stream.h"
#include "SerializableObject.h"
 
class FlowGraphNode : public SerializableObject
{
public:
    FlowGraphNode();
    virtual ~FlowGraphNode();
 
    void DetachInputs();
 
    //Inputs
public:
    size_t GetInputCount();
    std::string GetInputName(size_t i);
 
    void SetInput(size_t i, StreamDescriptor stream, bool force = false);
    void SetInput(const std::string& name, StreamDescriptor stream, bool force = false);
    virtual bool ValidateChannel(size_t i, StreamDescriptor stream);
 
    StreamDescriptor GetInput(size_t i);
 
protected:
    virtual void OnInputChanged(size_t i);
 
    //Parameters
public:
    FilterParameter& GetParameter(std::string s);
 
    typedef std::map<std::string, FilterParameter> ParameterMapType;
 
    bool HasParameter(std::string s)
    { return (m_parameters.find(s) != m_parameters.end()); }
 
    ParameterMapType::iterator GetParamBegin()
    { return m_parameters.begin(); }
 
    ParameterMapType::iterator GetParamEnd()
    { return m_parameters.end(); }
 
    size_t GetParamCount()
    { return m_parameters.size(); }
 
    virtual YAML::Node SerializeConfiguration(IDTable& table);
 
    virtual void LoadParameters(const YAML::Node& node, IDTable& table);
    virtual void LoadInputs(const YAML::Node& node, IDTable& table);
 
    bool IsDownstreamOf(std::set<FlowGraphNode*> nodes);
 
    // Accelerated waveform accessors
 
    enum DataLocation
    {
        LOC_CPU,
        LOC_GPU,
        LOC_DONTCARE
    };
 
    virtual DataLocation GetInputLocation();
 
    // Filter evaluation
    [[deprecated]]
    virtual void Refresh();
 
    //Filter evaluation (GPU accelerated)
    virtual void Refresh(vk::raii::CommandBuffer& cmdBuf, std::shared_ptr<QueueHandle> queue);
 
    //Input handling helpers
protected:
 
    WaveformBase* GetInputWaveform(size_t i);   //implementation in FlowGraphNode_inlines.h
 
    SparseAnalogWaveform* GetSparseAnalogInputWaveform(size_t i)
    { return dynamic_cast<SparseAnalogWaveform*>(GetInputWaveform(i)); }
 
    UniformAnalogWaveform* GetUniformAnalogInputWaveform(size_t i)
    { return dynamic_cast<UniformAnalogWaveform*>(GetInputWaveform(i)); }
 
    SparseDigitalWaveform* GetSparseDigitalInputWaveform(size_t i)
    { return dynamic_cast<SparseDigitalWaveform*>(GetInputWaveform(i)); }
 
    UniformDigitalWaveform* GetUniformDigitalInputWaveform(size_t i)
    { return dynamic_cast<UniformDigitalWaveform*>(GetInputWaveform(i)); }
 
    SparseDigitalBusWaveform* GetSparseDigitalBusInputWaveform(size_t i)
    { return dynamic_cast<SparseDigitalBusWaveform*>(GetInputWaveform(i)); }
 
    void CreateInput(const std::string& name);
 
    std::string GetInputDisplayName(size_t i);
 
protected:
    std::vector<std::string> m_signalNames;
 
    std::vector<StreamDescriptor> m_inputs;
 
    //Parameters
    ParameterMapType m_parameters;
 
public:
 
    sigc::signal<void()> signal_parametersChanged()
    { return m_parametersChangedSignal; }
 
    sigc::signal<void()> signal_inputsChanged()
    { return m_inputsChangedSignal; }
 
protected:
 
    sigc::signal<void()> m_parametersChangedSignal;
 
    sigc::signal<void()> m_inputsChangedSignal;
};
 
#endif