DynExp
Highly flexible laboratory automation for dynamically changing experiments.
DynExpInstr::FunctionGeneratorDefs::TriggerDescType Struct Reference

Type describing trigger parameters determining when the waveform is generated. More...

Public Types

enum  TriggerModeType { Continuous , ExternSingle , ExternStep , Manual }
 Type to determine the trigger mode. Not a strongly-typed enum to allow using the enumeration in a DynExp::ParamsBase::Param in class FunctionGeneratorParams. More...
 
enum  TriggerEdgeType { Rise , Fall }
 Type to determine at which edge of a trigger signal to trigger. Not a strongly-typed enum to allow using the enumeration in a DynExp::ParamsBase::Param in class FunctionGeneratorParams. More...
 

Public Member Functions

 TriggerDescType () noexcept=default
 
 TriggerDescType (TriggerModeType TriggerMode, TriggerEdgeType TriggerEdge) noexcept
 Constructs a TriggerDescType instance. More...
 

Public Attributes

TriggerModeType TriggerMode = TriggerModeType::Continuous
 Trigger mode. More...
 
TriggerEdgeType TriggerEdge = TriggerEdgeType::Rise
 Edge to trigger on. More...
 

Detailed Description

Type describing trigger parameters determining when the waveform is generated.

Definition at line 283 of file FunctionGenerator.h.

Member Enumeration Documentation

◆ TriggerEdgeType

Type to determine at which edge of a trigger signal to trigger. Not a strongly-typed enum to allow using the enumeration in a DynExp::ParamsBase::Param in class FunctionGeneratorParams.

Enumerator
Rise 

Trigger on rising edge.

Fall 

Trigger on falling edge.

Definition at line 302 of file FunctionGenerator.h.

◆ TriggerModeType

Type to determine the trigger mode. Not a strongly-typed enum to allow using the enumeration in a DynExp::ParamsBase::Param in class FunctionGeneratorParams.

Enumerator
Continuous 

Run continuously disabling the trigger.

ExternSingle 

Run once after an external trigger signal has been detected.

ExternStep 

Advance by a single (sweep) sample after an external trigger signal has been detected.

Manual 

Only trigger by a user command.

Definition at line 290 of file FunctionGenerator.h.

Constructor & Destructor Documentation

◆ TriggerDescType() [1/2]

DynExpInstr::FunctionGeneratorDefs::TriggerDescType::TriggerDescType ( )
defaultnoexcept

◆ TriggerDescType() [2/2]

DynExpInstr::FunctionGeneratorDefs::TriggerDescType::TriggerDescType ( TriggerModeType  TriggerMode,
TriggerEdgeType  TriggerEdge 
)
inlinenoexcept

Constructs a TriggerDescType instance.

Parameters
TriggerModeTrigger mode.
TriggerEdgeEdge to trigger on.

Definition at line 314 of file FunctionGenerator.h.

Member Data Documentation

◆ TriggerEdge

TriggerEdgeType DynExpInstr::FunctionGeneratorDefs::TriggerDescType::TriggerEdge = TriggerEdgeType::Rise

Edge to trigger on.

Definition at line 318 of file FunctionGenerator.h.

◆ TriggerMode

TriggerModeType DynExpInstr::FunctionGeneratorDefs::TriggerDescType::TriggerMode = TriggerModeType::Continuous

Trigger mode.

Definition at line 317 of file FunctionGenerator.h.


The documentation for this struct was generated from the following file: