WindowTrigger.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 WindowTrigger_h
#define WindowTrigger_h
 
#include "TwoLevelTrigger.h"
 
class WindowTrigger : public TwoLevelTrigger
{
public:
    WindowTrigger(Oscilloscope* scope);
    virtual ~WindowTrigger();
 
    virtual bool ValidateChannel(size_t i, StreamDescriptor stream) override;
 
    enum Crossing
    {
        CROSS_UPPER,
 
        CROSS_LOWER,
 
        CROSS_EITHER,
 
        CROSS_NONE,
    };
 
    enum WindowType
    {
        WINDOW_ENTER,
 
        WINDOW_EXIT,
 
        WINDOW_EXIT_TIMED,
 
        WINDOW_ENTER_TIMED
    };
 
    void SetCrossingDirection(Crossing dir)
    { m_crossingType.SetIntVal(dir); }
 
    Crossing GetCrossingDirection()
    { return (Crossing)m_crossingType.GetIntVal(); }
 
    void SetWindowType(WindowType type)
    { m_windowType.SetIntVal(type); }
 
    WindowType GetWindowType()
    { return (WindowType)m_windowType.GetIntVal(); }
 
    void SetWidth(int64_t ps)
    { m_width.SetIntVal(ps); }
 
    int64_t GetWidth()
    { return m_width.GetIntVal(); }
 
    static std::string GetTriggerName();
    TRIGGER_INITPROC(WindowTrigger);
 
protected:
 
    FilterParameter& m_width;
 
    FilterParameter& m_crossingType;
 
    FilterParameter& m_windowType;
};
 
#endif