ngscopeclient 0.1-dev+51fbda87c
NthEdgeBurstTrigger.h
Go to the documentation of this file.
1/***********************************************************************************************************************
2* *
3* libscopehal *
4* *
5* Copyright (c) 2012-2024 Andrew D. Zonenberg and contributors *
6* All rights reserved. *
7* *
8* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the *
9* following conditions are met: *
10* *
11* * Redistributions of source code must retain the above copyright notice, this list of conditions, and the *
12* following disclaimer. *
13* *
14* * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the *
15* following disclaimer in the documentation and/or other materials provided with the distribution. *
16* *
17* * Neither the name of the author nor the names of any contributors may be used to endorse or promote products *
18* derived from this software without specific prior written permission. *
19* *
20* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
21* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
22* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES *
23* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR *
24* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
25* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE *
26* POSSIBILITY OF SUCH DAMAGE. *
27* *
28***********************************************************************************************************************/
29
36#ifndef NthEdgeBurstTrigger_h
37#define NthEdgeBurstTrigger_h
38
44{
45public:
47 virtual ~NthEdgeBurstTrigger();
48
51 {
54
57 };
58
64 void SetSlope(EdgeType type)
65 { m_edgetype.SetIntVal(type); }
66
69 { return (EdgeType) m_edgetype.GetIntVal(); }
70
76 void SetIdleTime(int64_t idle)
77 { m_idletime.SetIntVal(idle); }
78
80 int64_t GetIdleTime()
81 { return m_idletime.GetIntVal(); }
82
88 void SetEdgeNumber(int64_t edge)
89 { m_edgenumber.SetIntVal(edge); }
90
92 int64_t GetEdgeNumber()
93 { return m_edgenumber.GetIntVal(); }
94
95 virtual bool ValidateChannel(size_t i, StreamDescriptor stream) override;
96
97 static std::string GetTriggerName();
98 TRIGGER_INITPROC(NthEdgeBurstTrigger);
99
100protected:
101
104
107
110};
111
112#endif
A parameter to a filter.
Definition: FilterParameter.h:86
void SetIntVal(int64_t i)
Sets the parameter to an integer value.
Definition: FilterParameter.cpp:307
int64_t GetIntVal() const
Returns the value of the parameter interpreted as an integer.
Definition: FilterParameter.h:119
Nth Edge Burst Trigger: triggers on a specific edge within a burst.
Definition: NthEdgeBurstTrigger.h:44
int64_t GetIdleTime()
Gets the idle time between bursts, in femtoseconds.
Definition: NthEdgeBurstTrigger.h:80
NthEdgeBurstTrigger(Oscilloscope *scope)
Initialize the trigger.
Definition: NthEdgeBurstTrigger.cpp:50
EdgeType GetSlope()
Gets the currently selected edge type.
Definition: NthEdgeBurstTrigger.h:68
EdgeType
Types of edges to trigger on.
Definition: NthEdgeBurstTrigger.h:51
@ EDGE_FALLING
High to low transition.
Definition: NthEdgeBurstTrigger.h:56
@ EDGE_RISING
Low to high transition.
Definition: NthEdgeBurstTrigger.h:53
void SetIdleTime(int64_t idle)
Set the minimum idle time between bursts.
Definition: NthEdgeBurstTrigger.h:76
FilterParameter & m_edgetype
Edge type.
Definition: NthEdgeBurstTrigger.h:103
FilterParameter & m_edgenumber
Index of target edge within the burst.
Definition: NthEdgeBurstTrigger.h:109
void SetEdgeNumber(int64_t edge)
Set the index of the edge to trigger on.
Definition: NthEdgeBurstTrigger.h:88
static std::string GetTriggerName()
Returns the constant trigger name "Nth Edge Burst".
Definition: NthEdgeBurstTrigger.cpp:77
void SetSlope(EdgeType type)
Set the type of the edge to trigger on.
Definition: NthEdgeBurstTrigger.h:64
int64_t GetEdgeNumber()
Get the index of the edge to trigger on.
Definition: NthEdgeBurstTrigger.h:92
FilterParameter & m_idletime
Idle time before a burst is considered to have ended.
Definition: NthEdgeBurstTrigger.h:106
Generic representation of an oscilloscope, logic analyzer, or spectrum analyzer.
Definition: Oscilloscope.h:50
Descriptor for a single stream coming off a channel.
Definition: StreamDescriptor.h:46
Abstract base class for oscilloscope / logic analyzer trigger inputs.
Definition: Trigger.h:46