DropoutTrigger Class Reference

Trigger when a signal stops toggling for some amount of time. More...

#include <DropoutTrigger.h>

Inheritance diagram for DropoutTrigger:

Collaboration diagram for DropoutTrigger:

Public Types
enum	EdgeType { EDGE_RISING , EDGE_FALLING , EDGE_ANY }
	Types of edges to trigger on. More...
enum	ResetType { RESET_OPPOSITE , RESET_NONE }
	Type of edge to reset on. More...
Public Types inherited from Trigger
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 }
	Conditions for triggers that perform logical comparisons of values. More...
typedef Trigger *(*	CreateProcType) (Oscilloscope *)
Public Types inherited from FlowGraphNode
enum	DataLocation { LOC_CPU , LOC_GPU , LOC_DONTCARE }
typedef std::map< std::string, FilterParameter >	ParameterMapType
	Short name for a map of strings to parameters.

Public Member Functions
	DropoutTrigger (Oscilloscope *scope)
	Initialize the trigger. More...
void	SetType (EdgeType type)
	Set the type of the edge to look for. More...
EdgeType	GetType ()
	Get the currently selected edge type.
void	SetResetType (ResetType type)
	Set the edge to reset on. More...
ResetType	GetResetType ()
	Get the currently selected reset type.
virtual bool	ValidateChannel (size_t i, StreamDescriptor stream) override
int64_t	GetDropoutTime ()
	Get the timeout for a quiet period on the bus to be considered a dropout.
void	SetDropoutTime (int64_t t)
	Set the timeout for a quiet period on the bus to be considered a dropout. More...
	TRIGGER_INITPROC (DropoutTrigger)
Public Member Functions inherited from Trigger
	Trigger (Oscilloscope *scope)
	Initialize a new trigger. More...
float	GetLevel ()
	Get the trigger level.
void	SetLevel (float level)
	Sets the trigger level. More...
Oscilloscope *	GetScope ()
	Gets the scope this trigger is attached to.
virtual std::string	GetTriggerDisplayName ()=0
virtual YAML::Node	SerializeConfiguration (IDTable &table) override
	Serializes this trigger's configuration to a YAML string. More...
Public Member Functions inherited from FlowGraphNode
void	DetachInputs ()
	Disconnects all inputs from the node without releasing them. More...
size_t	GetInputCount ()
std::string	GetInputName (size_t i)
void	SetInput (size_t i, StreamDescriptor stream, bool force=false)
	Connects a stream to the input of this node. More...
void	SetInput (const std::string &name, StreamDescriptor stream, bool force=false)
virtual bool	ValidateChannel (size_t i, StreamDescriptor stream)
StreamDescriptor	GetInput (size_t i)
	Gets the descriptor for one of our inputs.
FilterParameter &	GetParameter (std::string s)
bool	HasParameter (std::string s)
	Checks if we have a parameter with a given name. More...
ParameterMapType::iterator	GetParamBegin ()
	Returns an iterator to the beginning of our parameter map.
ParameterMapType::iterator	GetParamEnd ()
	Returns an iterator to the end of our parameter map.
size_t	GetParamCount ()
	Returns the number of parameter we have.
virtual YAML::Node	SerializeConfiguration (IDTable &table)
	Serializes this trigger's configuration to a YAML string. More...
virtual void	LoadParameters (const YAML::Node &node, IDTable &table)
	Load configuration from a save file. More...
virtual void	LoadInputs (const YAML::Node &node, IDTable &table)
bool	IsDownstreamOf (std::set< FlowGraphNode * > nodes)
	Determines if this node is downstream of any of the specified other nodes. More...
virtual DataLocation	GetInputLocation ()
	Gets the desired location of the nodes's input data. More...
virtual void	Refresh ()
	Evaluates a filter graph node. More...
virtual void	Refresh (vk::raii::CommandBuffer &cmdBuf, std::shared_ptr< QueueHandle > queue)
sigc::signal< void()>	signal_parametersChanged ()
sigc::signal< void()>	signal_inputsChanged ()

Static Public Member Functions
static std::string	GetTriggerName ()
	Returns the constant trigger name "Dropout".
Static Public Member Functions inherited from Trigger
static void	DoAddTriggerClass (std::string name, CreateProcType proc)
	Register a new trigger class for dynamic creation. More...
static void	EnumTriggers (std::vector< std::string > &names)
	Gets a list of all registered trigger types. More...
static Trigger *	CreateTrigger (std::string name, Oscilloscope *scope)
	Creates a new trigger for an oscilloscope. More...

Protected Attributes
FilterParameter &	m_type
	Target edge type.
FilterParameter &	m_time
	Dropout time.
FilterParameter &	m_reset
	Reset mode.
Protected Attributes inherited from Trigger
Oscilloscope *	m_scope
	The scope this trigger is part of.
FilterParameter &	m_level
	"Trigger level" parameter
Protected Attributes inherited from FlowGraphNode
std::vector< std::string >	m_signalNames
	Names of signals we take as input.
std::vector< StreamDescriptor >	m_inputs
	The channel (if any) connected to each of our inputs.
ParameterMapType	m_parameters
sigc::signal< void()>	m_parametersChangedSignal
	Signal emitted when the set of parameters changes.
sigc::signal< void()>	m_inputsChangedSignal
	Signal emitted when the set of inputs changes.

Additional Inherited Members
Protected Types inherited from Trigger
typedef std::map< std::string, CreateProcType >	CreateMapType
	Helper typedef for m_createprocs.
Protected Member Functions inherited from FlowGraphNode
virtual void	OnInputChanged (size_t i)
	Called when a new input is connected to the node. More...
WaveformBase *	GetInputWaveform (size_t i)
	Gets the waveform attached to the specified input. More...
SparseAnalogWaveform *	GetSparseAnalogInputWaveform (size_t i)
	Gets the analog waveform attached to the specified input.
UniformAnalogWaveform *	GetUniformAnalogInputWaveform (size_t i)
	Gets the analog waveform attached to the specified input.
SparseDigitalWaveform *	GetSparseDigitalInputWaveform (size_t i)
	Gets the digital waveform attached to the specified input.
UniformDigitalWaveform *	GetUniformDigitalInputWaveform (size_t i)
	Gets the digital waveform attached to the specified input.
SparseDigitalBusWaveform *	GetSparseDigitalBusInputWaveform (size_t i)
	Gets the digital bus waveform attached to the specified input.
void	CreateInput (const std::string &name)
	Creates and names an input signal.
std::string	GetInputDisplayName (size_t i)
	Gets the display name for one of our inputs. More...
Static Protected Attributes inherited from Trigger
static CreateMapType	m_createprocs
	Map of trigger type names to factory methods.

Detailed Description

Trigger when a signal stops toggling for some amount of time.

Member Enumeration Documentation

EdgeType

enum DropoutTrigger::EdgeType

Types of edges to trigger on.

Enumerator
EDGE_RISING	Low to high transition.
EDGE_FALLING	High to low transition.
EDGE_ANY	Either rising or falling transition.

ResetType

enum DropoutTrigger::ResetType

Type of edge to reset on.

Enumerator
RESET_OPPOSITE	Reset on the opposite kind of edge.
RESET_NONE	Normal behavior.

Constructor & Destructor Documentation

DropoutTrigger()

DropoutTrigger::DropoutTrigger

(

Oscilloscope *

scope

)

Initialize the trigger.

Parameters

scope

The scope this trigger will be used with

Member Function Documentation

SetDropoutTime()

void DropoutTrigger::SetDropoutTime ( int64_t  t )

inline

Set the timeout for a quiet period on the bus to be considered a dropout.

Parameters

t	Dropout time, in fs

SetResetType()

void DropoutTrigger::SetResetType ( ResetType  type )

inline

Set the edge to reset on.

TODO: document what this means more

Parameters

type	Reset type

SetType()

void DropoutTrigger::SetType ( EdgeType  type )

inline

Set the type of the edge to look for.

Parameters

type

Edge type

ValidateChannel()

bool DropoutTrigger::ValidateChannel ( size_t  i, StreamDescriptor  stream  )

overridevirtual

Reimplemented from FlowGraphNode.

---

The documentation for this class was generated from the following files:

• lib/scopehal/DropoutTrigger.h
• lib/scopehal/DropoutTrigger.cpp