Trigger.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 Trigger_h
#define Trigger_h
 
#include "FlowGraphNode.h"
 
class Trigger : public FlowGraphNode
{
public:
    Trigger(Oscilloscope* scope);
    virtual ~Trigger();
 
    virtual void Refresh(vk::raii::CommandBuffer& cmdBuf, std::shared_ptr<QueueHandle> queue) override;
 
    float GetLevel()
    { return m_level.GetFloatVal(); }
 
    float GetUpperLevel()
    { return m_level.GetFloatVal(); }
 
    void SetLevel(float level)
    {
        m_level.SetFloatVal(level);
        m_triggerLevel.SetFloatVal(level);
        m_upperLevel.SetFloatVal(level);
    }
 
    void SetUpperLevel(float level)
    {
        m_level.SetFloatVal(level);
        m_triggerLevel.SetFloatVal(level);
        m_upperLevel.SetFloatVal(level);
    }
 
    Oscilloscope* GetScope()
    { return m_scope; }
 
    enum Condition
    {
        CONDITION_EQUAL,
 
        CONDITION_NOT_EQUAL,
 
        CONDITION_LESS,
 
        CONDITION_LESS_OR_EQUAL,
 
        CONDITION_GREATER,
 
        CONDITION_GREATER_OR_EQUAL,
 
        CONDITION_BETWEEN,
 
        CONDITION_NOT_BETWEEN,
 
        CONDITION_ANY
    };
 
protected:
 
    Oscilloscope* m_scope;
 
    FilterParameter& m_level;
    FilterParameter& m_triggerLevel;
    FilterParameter& m_upperLevel;
 
public:
    virtual std::string GetTriggerDisplayName() =0;
 
    typedef Trigger* (*CreateProcType)(Oscilloscope*);
    static void DoAddTriggerClass(std::string name, CreateProcType proc);
 
    static void EnumTriggers(std::vector<std::string>& names);
    static Trigger* CreateTrigger(std::string name, Oscilloscope* scope);
 
    virtual YAML::Node SerializeConfiguration(IDTable& table) override;
 
protected:
    typedef std::map< std::string, CreateProcType > CreateMapType;
 
    static CreateMapType m_createprocs;
};
 
#define TRIGGER_INITPROC(T) \
    static Trigger* CreateInstance(Oscilloscope* scope) \
    { return new T(scope); } \
    virtual std::string GetTriggerDisplayName() override \
    { return GetTriggerName(); }
 
#define AddTriggerClass(T) Trigger::DoAddTriggerClass(T::GetTriggerName(), T::CreateInstance)
 
#endif