DynExp
Highly flexible laboratory automation for dynamically changing experiments.
DynExpModule::SignalDesigner Class Reference
+ Inheritance diagram for DynExpModule::SignalDesigner:

Public Types

using ParamsType = SignalDesignerParams
 
using ConfigType = SignalDesignerConfigurator
 
using ModuleDataType = SignalDesignerData
 
- Public Types inherited from DynExp::QModuleBase
using ParamsType = QModuleParamsBase
 Type of the parameter class belonging to this Object type. Declare this alias in every derived class with the respective parameter class accompanying the derived Object. More...
 
using ConfigType = QModuleConfiguratorBase
 Type of the configurator class belonging to this Object type. Declare this alias in every derived class with the respective configurator class accompanying the derived Object. More...
 
using ModuleDataType = QModuleDataBase
 Type of the data class belonging to this ModuleBase type. Declare this alias in every derived class with the respective data class accompanying the derived ModuleBase. More...
 
- Public Types inherited from DynExp::ModuleBase
using ParamsType = ModuleParamsBase
 Type of the parameter class belonging to this Object type. Declare this alias in every derived class with the respective parameter class accompanying the derived Object. More...
 
using ConfigType = ModuleConfiguratorBase
 Type of the configurator class belonging to this Object type. Declare this alias in every derived class with the respective configurator class accompanying the derived Object. More...
 
using ModuleDataType = ModuleDataBase
 Type of the data class belonging to this ModuleBase type. Declare this alias in every derived class with the respective data class accompanying the derived ModuleBase. More...
 
using ModuleDataTypeSyncPtrType = Util::SynchronizedPointer< ModuleDataType >
 Alias for the return type of ModuleBase::GetModuleData(). Data class instances wrapped into Util::SynchronizedPointer can be accessed in a thread-safe way. More...
 
using ModuleDataTypeSyncPtrConstType = Util::SynchronizedPointer< const ModuleDataType >
 Alias for the return type of ModuleBase::GetModuleData() const. Data class instances wrapped into Util::SynchronizedPointer can be accessed in a thread-safe way. More...
 
using ModuleDataGetterType = Util::CallableMemberWrapper< ModuleBase, ModuleDataTypeSyncPtrType(ModuleBase::*)(const std::chrono::milliseconds)>
 Invoking an instance of this alias is supposed to call ModuleBase::GetModuleData() of the instance the Util::CallableMemberWrapper has been constructed with. More...
 
- Public Types inherited from DynExp::RunnableObject
using ParamsType = RunnableObjectParams
 Type of the parameter class belonging to this Object type. Declare this alias in every derived class with the respective parameter class accompanying the derived Object. More...
 
using ConfigType = RunnableObjectConfigurator
 Type of the configurator class belonging to this Object type. Declare this alias in every derived class with the respective configurator class accompanying the derived Object. More...
 
- Public Types inherited from DynExp::Object
using ParamsType = ParamsBase
 Type of the parameter class belonging to this Object type. Declare this alias in every derived class with the respective parameter class accompanying the derived Object. More...
 
using ParamsTypeSyncPtrType = Util::SynchronizedPointer< ParamsType >
 Alias for the return type of Object::GetParams(). Parameters wrapped into Util::SynchronizedPointer can be accessed in a thread-safe way. More...
 
using ParamsConstTypeSyncPtrType = Util::SynchronizedPointer< const ParamsType >
 Alias for the return type of Object::GetParams() const. Parameters wrapped into Util::SynchronizedPointer can be accessed in a thread-safe way. More...
 
using ConfigType = ConfiguratorBase
 Type of the configurator class belonging to this Object type. Declare this alias in every derived class with the respective configurator class accompanying the derived Object. More...
 
using ParamsGetterType = Util::CallableMemberWrapper< Object, decltype(&Object::GetParams)>
 Invoking an instance of this alias is supposed to call Object::GetParams() of the instance the Util::CallableMemberWrapper has been constructed with. More...
 

Public Member Functions

 SignalDesigner (const std::thread::id OwnerThreadID, DynExp::ParamsBasePtrType &&Params)
 
virtual ~SignalDesigner ()=default
 
virtual std::string GetName () const override
 Returns the name of this Object type. More...
 
virtual std::string GetCategory () const override
 Returns the category of this Object type. More...
 
- Public Member Functions inherited from DynExp::QModuleBase
 QModuleBase (const std::thread::id OwnerThreadID, DynExp::ParamsBasePtrType &&Params)
 Constructs a QModuleBase instance. More...
 
virtual ~QModuleBase ()=0
 
bool HasUI () const noexcept override final
 Determines whether this module possesses a user interface (UI) which is shown in a window dedicated to the module. More...
 
QAction & InitUI (DynExpManager &DynExpMgr, QMdiArea *const MdiArea)
 Sets up the module's user interface widgets and window frames. Called by the main user interface thread in DynExpManager::RegisterModuleUI(). More...
 
void HideUI ()
 Removes MdiSubWindow, DockWidget, and ModuleWindowFocusAction setting them to nullptr. More...
 
void DisableUI ()
 Disables all user interface controls in Widget. Does nothing if Widget is nullptr. More...
 
void UpdateUI ()
 Enables the user interface controls in Widget. Does nothing if Widget is nullptr. Calls UpdateUIChild(). More...
 
void UpdateModuleWindowFocusAction ()
 Updates the icon assigned to ModuleWindowFocusAction depending on whether Widget is docked to or undocked from MdiArea. Called by the main user interface thread in DynExpManager::UpdateModuleWindowsActionIcons(). More...
 
void DockWindow () noexcept
 Docks Widget to MdiArea. Does nothing if any of Widget, MdiArea, MdiSubWindow, or DockWidget are nullptr. More...
 
void UndockWindow () noexcept
 Undocks Widget from MdiArea. Does nothing if any of Widget, MdiArea, MdiSubWindow, or DockWidget are nullptr. More...
 
void DockUndockWindow () noexcept
 Toggles the docking state of Widget. Does nothing if any of Widget, MdiArea, MdiSubWindow, or DockWidget are nullptr. More...
 
void SetFocus () noexcept
 Focuses/activates Widget and moves it on top of other windows if possible. Does nothing if any of Widget, MdiArea, MdiSubWindow, or DockWidget are nullptr. More...
 
void FocusMainWindow () noexcept
 Focuses/activates DynExp's main window calling DynExpManager::FocusMainWindow(). Does nothing if Widget is nullptr. More...
 
void SendKeyPressEventToMainWindow (QKeyEvent *Event) noexcept
 Sends a Qt key press event to DynExp's main window calling DynExpManager::PostKeyPressEvent(). Does nothing if Widget is nullptr. More...
 
bool IsWindowDocked () noexcept
 Checks whether Widget is docked. More...
 
bool IsActiveWindow ()
 Checks whether Widget is docked and active. More...
 
- Public Member Functions inherited from DynExp::ModuleBase
 ModuleBase (const std::thread::id OwnerThreadID, ParamsBasePtrType &&Params)
 Constructs a ModuleBase instance. More...
 
virtual ~ModuleBase ()=0
 
void RestoreWindowStatesFromParams ()
 RestoreWindowStatesFromParams() only calls RestoreWindowStatesFromParamsChild(). Override RestoreWindowStatesFromParamsChild() to restore the styles of possibly owned windows according to the style saved in the module's parameters. More...
 
void UpdateParamsFromWindowStates ()
 UpdateParamsFromWindowStates() only calls UpdateParamsFromWindowStatesChild(). Override UpdateParamsFromWindowStatesChild() to store the styles of possibly owned windows in the module's parameters. More...
 
ModuleDataTypeSyncPtrType GetModuleData (const std::chrono::milliseconds Timeout=GetModuleDataTimeoutDefault)
 Locks the mutex of the module data class instance ModuleData assigned to this ModuleBase instance and returns a pointer to the locked ModuleData. Module data should not be locked by having called this function while subsequently calling a derived module's method which also makes use of the module's data by locking it. If this happens, the module data's mutex is locked recursively. In principle, this does no harm since Util::ISynchronizedPointerLockable supports that. But, it is not considered good practice. More...
 
ModuleDataTypeSyncPtrConstType GetModuleData (const std::chrono::milliseconds Timeout=GetModuleDataTimeoutDefault) const
 Locks the mutex of the module data class instance ModuleData assigned to this ModuleBase instance and returns a pointer to the locked ModuleData. Module data should not be locked by having called this function while subsequently calling a derived module's method which also makes use of the module's data by locking it. If this happens, the module data's mutex is locked recursively. In principle, this does no harm since Util::ISynchronizedPointerLockable supports that. But, it is not considered good practice. More...
 
void EnqueueEvent (ModuleDataBase::EventPtrType &&Event) const
 Enqueues Event at the module event queue's back. Takes ownership of the event. Notifies the module owning the respective ModuleDataBase's instance that a new event has been enqueued. More...
 
template<typename ReceiverType , typename EventType , typename... ArgsTs>
void MakeAndEnqueueEvent (ReceiverType *Receiver, EventType EventFuncPtr, ArgsTs &&...Args) const
 Calls MakeEvent() to construct a new event and subsequently enqueues the event into the module's event queue. Logical const-ness: this is a const member function to allow pointers to const ModuleBase inserting events into the module's event queue. These kind of pointers are e.g. returned by RunnableInstance::GetOwner() which can be called by events' EventBase::InvokeChild() functions. For const ModuleBase*, it is possible to insert events into the event queue, but not to change the ModuleBase object itself (e.g. calling Object::Reset()). More...
 
virtual bool TreatModuleExceptionsAsWarnings () const
 Determines whether this module should be terminated if an exception leaves the module's main loop or respective event handlers. More...
 
virtual std::chrono::milliseconds GetMainLoopDelay () const
 Specifies in which time intervals the module's event queue runs to handle pending events. More...
 
- Public Member Functions inherited from DynExp::RunnableObject
 RunnableObject (const std::thread::id OwnerThreadID, ParamsBasePtrType &&Params)
 Constructs an Object instance. More...
 
virtual ~RunnableObject ()=0
 
void SetPaused (bool Pause, std::string Description="")
 Pauses or resumes a RunnableObject instance. Its thread stays running, but the instance does not perform any action while it is paused. More...
 
bool IsRunning () const noexcept
 Returns Running. More...
 
bool IsPaused () const noexcept
 Returns Paused. More...
 
bool IsExiting () const noexcept
 Returns ShouldExit. More...
 
auto GetStartupType () const noexcept
 Returns Startup. More...
 
auto GetReasonWhyPaused () const
 Returns ReasonWhyPaused. More...
 
bool Run (QWidget *ParentWidget=nullptr)
 Starts the RunnableObject instance's thread and ensures that all Object instances linked to this instance via ObjectLink parameters are in a ready state. Calls RunChild() which is to be overridden by derived classes to start a thread and to pass this thread back by calling StoreThread(). More...
 
bool RunIfRunAutomatic ()
 Calls Run() if RunnableObjectParams::Startup is set to RunnableObjectParams::Automatic. More...
 
bool RunIfRunOnCreation ()
 Calls Run() if RunnableObjectParams::Startup is set to RunnableObjectParams::OnCreation. More...
 
void Terminate (bool Force=false, const std::chrono::milliseconds Timeout=TerminateTimeoutDefault)
 Notifies the RunnableObject instance's thread to terminate and waits until it has ended. Calls TerminateImpl(). More...
 
- Public Member Functions inherited from Util::INonCopyable
 INonCopyable (const INonCopyable &)=delete
 
INonCopyableoperator= (const INonCopyable &)=delete
 
- Public Member Functions inherited from DynExp::Object
ItemIDType GetID () const noexcept
 Returns the ID of this Object instance. Thread-safe since ID is const. More...
 
std::string GetCategoryAndName () const
 Builds a string from an Object's category and name to allow the user to identify an Object's type. More...
 
void EnsureReadyState (bool IsAutomaticStartup)
 Ensures that this Object instance is ready by possibly starting its worker thread or by opening connections to hardware devices. More...
 
void CheckLinkedObjectStates () const
 Checks whether Object instances this instance uses are in a ready state. Override CheckLinkedObjectStatesChild() to implement this behavior. More...
 
void Reset ()
 Resets this Object instance (including all its derived classes) by calling ResetImpl(). A reset implies that the derived classes reload all their parameters from Params and that all LinkedObjectWrapper instances owned by this Object instance become invalidated. More...
 
void BlockIfUnused (const std::chrono::milliseconds Timeout=Util::ILockable::DefaultTimeout)
 Blocks this Object instance setting Object::IsBlocked to true. Refer to Object::IsBlocked for the consequences. More...
 
ParamsConstTypeSyncPtrType GetParams (const std::chrono::milliseconds Timeout=GetParamsTimeoutDefault) const
 Locks the mutex of the parameter class instance Params assigned to this Object instance and returns a pointer to the locked Params. More...
 
ParamsTypeSyncPtrType GetParams (const std::chrono::milliseconds Timeout=GetParamsTimeoutDefault)
 Locks the mutex of the parameter class instance Params assigned to this Object instance and returns a pointer to the locked Params. More...
 
auto GetObjectName (const std::chrono::milliseconds Timeout=GetParamsTimeoutDefault) const
 Returns the name of this Object instance. More...
 
bool IsSharedUsageEnabled (const std::chrono::milliseconds Timeout=GetParamsTimeoutDefault) const
 Returns whether shared usage has been enabled for this Object instance. Refer to ParamsBase::UsageType. More...
 
void SetWarning (std::string Description, int ErrorCode) const
 Setter for Object::Warning. Sets the warning by a description and an error code. More...
 
void SetWarning (const Util::Exception &e) const
 Setter for Object::Warning. Sets the warning by retrieving the warning data from an exception e. More...
 
void ClearWarning () const
 Resets Object::Warning. More...
 
auto GetWarning () const
 Returns Object::Warning in a thread-safe way by copying its internal data. More...
 
std::exception_ptr GetException (const std::chrono::milliseconds Timeout=Util::ILockable::DefaultTimeout) const
 Returns a pointer to the exception which has caused this Object instance to fail. More...
 
bool IsReady () const
 Returns wheter this Object instance is ready (e.g. it is running or connected to a hardware device) and not blocked (refer to Object::IsBlocked). More...
 
auto GetUseCount (const std::chrono::milliseconds Timeout=Util::ILockable::DefaultTimeout) const
 Counts the registered useres in a thread-safe way. More...
 
bool IsUnused (const std::chrono::milliseconds Timeout=Util::ILockable::DefaultTimeout) const
 Returns whether this Object instance is used by other instances. More...
 
auto GetUserIDs (const std::chrono::milliseconds Timeout=Util::ILockable::DefaultTimeout) const
 Returns a list of the IDs of the registered users in a thread-safe way. More...
 
auto GetUserNamesString (const std::chrono::milliseconds Timeout=Util::ILockable::DefaultTimeout) const
 Builds a string describing which users are registered containing their object names, categories and type names in a thread-safe way. More...
 

Static Public Member Functions

constexpr static auto Name () noexcept
 
constexpr static auto Category () noexcept
 
- Static Public Member Functions inherited from DynExp::ModuleBase
constexpr static auto Category () noexcept
 Every derived class has to redefine this function. More...
 
- Static Public Member Functions inherited from DynExp::Object
static std::string CategoryAndNameToStr (const std::string &Category, const std::string &Name)
 Builds a string from an Object's category and name to allow the user to identify an Object's type. More...
 

Private Member Functions

Util::DynExpErrorCodes::DynExpErrorCodes ModuleMainLoop (DynExp::ModuleInstance &Instance) override final
 Module main loop. The function is executed periodically by the module thread. Also refer to GetMainLoopDelay(). More...
 
void ResetImpl (dispatch_tag< QModuleBase >) override final
 
std::unique_ptr< DynExp::QModuleWidgetMakeUIWidget () override final
 Used by InitUI() as a factory function for the module's user interface widget. Create the widget here using std::make_unique and then use Connect() to connect Qt signals to the module's event functions. More...
 
void UpdateUIChild (const ModuleBase::ModuleDataGetterType &ModuleDataGetter) override final
 
void UpdateWaveform (Util::SynchronizedPointer< SignalDesignerData > &ModuleData, bool Autostart=false) const
 
void OnInit (DynExp::ModuleInstance *Instance) const override final
 This event is triggered right before the module thread starts. Override it to lock instruments this module depends on (via RunnableInstance::LockObject()) and to register/subscribe for events (via InterModuleEvent::Register()). More...
 
void OnExit (DynExp::ModuleInstance *Instance) const override final
 This event is triggered right before the module thread terminates (not due to an exception, in this case refer to ModuleBase::OnError). Override it to unlock instruments this module depends on (via RunnableInstance::UnlockObject()) and to deregister/unsubscribe from events (via InterModuleEvent::Deregister()). More...
 
void OnSourceChanged (DynExp::ModuleInstance *Instance, int Index) const
 
void OnSignalTypeChanged (DynExp::ModuleInstance *Instance, QString Text) const
 
void OnStreamSizeChanged (DynExp::ModuleInstance *Instance, int Value) const
 
void OnResetStreamSize (DynExp::ModuleInstance *Instance, bool) const
 
void OnFrequencyChanged (DynExp::ModuleInstance *Instance, double Value) const
 
void OnPhaseChanged (DynExp::ModuleInstance *Instance, double Value) const
 
void OnAmplitudeChanged (DynExp::ModuleInstance *Instance, double Value) const
 
void OnOffsetChanged (DynExp::ModuleInstance *Instance, double Value) const
 
void OnDutyCycleChanged (DynExp::ModuleInstance *Instance, double Value) const
 
void OnPulsesChanged (DynExp::ModuleInstance *Instance) const
 
void OnTriggerModeChanged (DynExp::ModuleInstance *Instance, QString Text) const
 
void OnTriggerEdgeChanged (DynExp::ModuleInstance *Instance, QString Text) const
 
void OnAutostartChanged (DynExp::ModuleInstance *Instance, int Value) const
 
void OnPersistParametersClicked (DynExp::ModuleInstance *Instance, bool Value) const
 
void OnStart (DynExp::ModuleInstance *Instance, bool) const
 
void OnStop (DynExp::ModuleInstance *Instance, bool) const
 
void OnForceTrigger (DynExp::ModuleInstance *Instance, bool) const
 

Additional Inherited Members

- Public Attributes inherited from DynExp::ModuleBase
ModuleThreadOnlyType ModuleThreadOnly
 Allow exclusive access to some of ModuleBase's private methods to the module thread ModuleThreadMain(). More...
 
EventListenersOnlyType EventListenersOnly
 Allow exclusive access to some of ModuleBase's private methods to any TypedEventListeners class. More...
 
- Public Attributes inherited from DynExp::RunnableObject
RunnableInstanceOnlyType RunnableInstanceOnly
 Allow exclusive access to some of RunnableObject's private methods to class RunnableInstance. More...
 
- Public Attributes inherited from DynExp::Object
LinkedObjectWrapperOnlyType LinkedObjectWrapperOnly
 Allow exclusive access to some of Object's private methods to any LinkedObjectWrapper<T>. More...
 
- Static Public Attributes inherited from DynExp::ModuleBase
static constexpr auto GetModuleDataTimeoutDefault = std::chrono::milliseconds(1000)
 Determines the default timeout for GetModuleData() to lock the mutex synchronizing the module's data ModuleData. More...
 
- Static Public Attributes inherited from DynExp::RunnableObject
static constexpr auto ShortTimeoutDefault = std::chrono::milliseconds(50)
 Default timeout e.g. used as a default for calls to InstrumentBase::GetInstrumentData or ModuleBase::GetModuleData. More...
 
static constexpr auto TerminateTimeoutDefault = std::chrono::milliseconds(3000)
 Default timeout used as a default for calls to RunnableObject::Terminate. More...
 
- Static Public Attributes inherited from DynExp::Object
static constexpr std::chrono::milliseconds GetParamsTimeoutDefault = std::chrono::milliseconds(100)
 Default timeout used by Object::GetParams() to lock the mutex of the parameter instance assigned to this Object instance. More...
 
- Protected Member Functions inherited from DynExp::QModuleBase
template<typename SenderType , typename SignalType , typename ReceiverType , typename EventType >
void Connect (SenderType *Sender, SignalType Signal, ReceiverType *Receiver, EventType Event)
 Uses Qt's connect mechanism to connect a QObject's signal to a DynExp module's event. By directly connecting slots to signals via QObject::connect(), the slot function runs in the user interface thread. In contrast, this function connects a signal to a lambda function, which itself enqueues an event in the module's event queue. The event runs in the module thread. Arguments passed from the signal to the lambda function are forwarded to the event. More...
 
template<typename WidgetType >
WidgetType * GetWidget () const
 Getter for Widget. More...
 
- Protected Member Functions inherited from DynExp::RunnableObject
void Init ()
 Initializes member variables in case of a reset. More...
 
std::promise< void > MakeThreadExitedPromise ()
 Helper function to be used by overridden RunChild() functions in derived classes to (re)initialize the ThreadExitedSignal future and to provide the derived class a promise to signal the RunnableObject instance that its thread has terminated. More...
 
void StoreThread (std::thread &&Thread) noexcept
 Stores a thread constructed by a derived class overriding RunChild() in Thread taking ownership of the thread. Only call this function within RunChild()! More...
 
bool IsCallFromRunnableThread () const
 Checks whether Thread's id matches the id of the calling thread. This is thread-safe if the function is called by the RunnableObject instance's thread since Terminate() joins the threads before changing the Thread member. It is also thread-safe if the function is called by the thread owning the the RunnableObject instance since Run() and Terminate() can only be called by this thread. Only Run() and Terminate() (indirectly) modify Thread. More...
 
void EnsureCallFromRunnableThread () const
 Asserts that the call to this function is performed from the RunnableObject instance's thread by calling IsCallFromRunnableThread(). More...
 
void SetReasonWhyPaused (std::string Description)
 Sets the reason why this RunnableObject instance has been paused. More...
 
void SetReasonWhyPaused (const Util::Exception &e)
 Sets the reason why this RunnableObject instance has been paused. More...
 
void ClearReasonWhyPaused ()
 Removes the reason why this RunnableObject instance has been paused (since it is resumed). More...
 
- Protected Member Functions inherited from Util::INonCopyable
constexpr INonCopyable ()=default
 
 ~INonCopyable ()=default
 
- Protected Member Functions inherited from DynExp::Object
 Object (const std::thread::id OwnerThreadID, ParamsBasePtrType &&Params)
 Constructs an Object instance. More...
 
virtual ~Object ()=0
 
void EnsureCallFromOwningThread () const
 Asserts that the call to this function is performed from the thread which constructed this Object instance (the thread with the id stored in Object::OwnerThreadID). More...
 
ParamsTypeSyncPtrType GetNonConstParams (const std::chrono::milliseconds Timeout=GetParamsTimeoutDefault) const
 Allows derived Objects to edit their own parameters - even in const task functions (for instruments) or event functions (for modules). More...
 
auto LockUserList (const std::chrono::milliseconds Timeout=Util::ILockable::DefaultTimeout)
 Locks the user list for thread-safe manipulation. More...
 
void DeregisterAllUnsafe ()
 Deregisters all users and notifies them that they need to check the states of their used linked objects. More...
 
auto GetUseCountUnsafe ()
 
auto GetUserNamesStringUnsafe () const
 
bool IsUnusedUnsafe ()
 Returns whether this Object instance is used by other instances (not thread-safe). More...
 
- Static Protected Member Functions inherited from DynExp::ModuleBase
static auto GetExceptionUnsafe (const ModuleDataTypeSyncPtrConstType &ModuleDataPtr)
 Getter for ModuleDataBase::ModuleException assuming that the module data has already been locked. More...
 

Detailed Description

Definition at line 135 of file SignalDesigner.h.

Member Typedef Documentation

◆ ConfigType

◆ ModuleDataType

◆ ParamsType

Constructor & Destructor Documentation

◆ SignalDesigner()

DynExpModule::SignalDesigner::SignalDesigner ( const std::thread::id  OwnerThreadID,
DynExp::ParamsBasePtrType &&  Params 
)
inline

Definition at line 145 of file SignalDesigner.h.

◆ ~SignalDesigner()

virtual DynExpModule::SignalDesigner::~SignalDesigner ( )
virtualdefault

Member Function Documentation

◆ Category()

constexpr static auto DynExpModule::SignalDesigner::Category ( )
inlinestaticconstexprnoexcept

Definition at line 143 of file SignalDesigner.h.

◆ GetCategory()

virtual std::string DynExpModule::SignalDesigner::GetCategory ( ) const
inlineoverridevirtual

Returns the category of this Object type.

Reimplemented from DynExp::ModuleBase.

Definition at line 150 of file SignalDesigner.h.

◆ GetName()

virtual std::string DynExpModule::SignalDesigner::GetName ( ) const
inlineoverridevirtual

Returns the name of this Object type.

Implements DynExp::Object.

Definition at line 149 of file SignalDesigner.h.

◆ MakeUIWidget()

std::unique_ptr< DynExp::QModuleWidget > DynExpModule::SignalDesigner::MakeUIWidget ( )
finaloverrideprivatevirtual

Used by InitUI() as a factory function for the module's user interface widget. Create the widget here using std::make_unique and then use Connect() to connect Qt signals to the module's event functions.

Returns
Return the created user interface widget.

Implements DynExp::QModuleBase.

Definition at line 356 of file SignalDesigner.cpp.

◆ ModuleMainLoop()

Util::DynExpErrorCodes::DynExpErrorCodes DynExpModule::SignalDesigner::ModuleMainLoop ( DynExp::ModuleInstance Instance)
finaloverrideprivatevirtual

Module main loop. The function is executed periodically by the module thread. Also refer to GetMainLoopDelay().

Parameters
InstanceHandle to the module thread's data
Returns
Return Util::DynExpErrorCodes::NoError if module loop should continue, annother error code otherwise.

Implements DynExp::ModuleBase.

Definition at line 343 of file SignalDesigner.cpp.

◆ Name()

constexpr static auto DynExpModule::SignalDesigner::Name ( )
inlinestaticconstexprnoexcept

Definition at line 142 of file SignalDesigner.h.

◆ OnAmplitudeChanged()

void DynExpModule::SignalDesigner::OnAmplitudeChanged ( DynExp::ModuleInstance Instance,
double  Value 
) const
private

Definition at line 529 of file SignalDesigner.cpp.

◆ OnAutostartChanged()

void DynExpModule::SignalDesigner::OnAutostartChanged ( DynExp::ModuleInstance Instance,
int  Value 
) const
private

Definition at line 588 of file SignalDesigner.cpp.

◆ OnDutyCycleChanged()

void DynExpModule::SignalDesigner::OnDutyCycleChanged ( DynExp::ModuleInstance Instance,
double  Value 
) const
private

Definition at line 545 of file SignalDesigner.cpp.

◆ OnExit()

void DynExpModule::SignalDesigner::OnExit ( DynExp::ModuleInstance Instance) const
finaloverrideprivatevirtual

This event is triggered right before the module thread terminates (not due to an exception, in this case refer to ModuleBase::OnError). Override it to unlock instruments this module depends on (via RunnableInstance::UnlockObject()) and to deregister/unsubscribe from events (via InterModuleEvent::Deregister()).

Parameters
InstanceHandle to the module thread's data

Reimplemented from DynExp::ModuleBase.

Definition at line 462 of file SignalDesigner.cpp.

◆ OnForceTrigger()

void DynExpModule::SignalDesigner::OnForceTrigger ( DynExp::ModuleInstance Instance,
bool   
) const
private

Definition at line 618 of file SignalDesigner.cpp.

◆ OnFrequencyChanged()

void DynExpModule::SignalDesigner::OnFrequencyChanged ( DynExp::ModuleInstance Instance,
double  Value 
) const
private

Definition at line 513 of file SignalDesigner.cpp.

◆ OnInit()

void DynExpModule::SignalDesigner::OnInit ( DynExp::ModuleInstance Instance) const
finaloverrideprivatevirtual

This event is triggered right before the module thread starts. Override it to lock instruments this module depends on (via RunnableInstance::LockObject()) and to register/subscribe for events (via InterModuleEvent::Register()).

Parameters
InstanceHandle to the module thread's data

Reimplemented from DynExp::ModuleBase.

Definition at line 454 of file SignalDesigner.cpp.

◆ OnOffsetChanged()

void DynExpModule::SignalDesigner::OnOffsetChanged ( DynExp::ModuleInstance Instance,
double  Value 
) const
private

Definition at line 537 of file SignalDesigner.cpp.

◆ OnPersistParametersClicked()

void DynExpModule::SignalDesigner::OnPersistParametersClicked ( DynExp::ModuleInstance Instance,
bool  Value 
) const
private

Definition at line 596 of file SignalDesigner.cpp.

◆ OnPhaseChanged()

void DynExpModule::SignalDesigner::OnPhaseChanged ( DynExp::ModuleInstance Instance,
double  Value 
) const
private

Definition at line 521 of file SignalDesigner.cpp.

◆ OnPulsesChanged()

void DynExpModule::SignalDesigner::OnPulsesChanged ( DynExp::ModuleInstance Instance) const
private

Definition at line 553 of file SignalDesigner.cpp.

◆ OnResetStreamSize()

void DynExpModule::SignalDesigner::OnResetStreamSize ( DynExp::ModuleInstance Instance,
bool   
) const
private

Definition at line 505 of file SignalDesigner.cpp.

◆ OnSignalTypeChanged()

void DynExpModule::SignalDesigner::OnSignalTypeChanged ( DynExp::ModuleInstance Instance,
QString  Text 
) const
private

Definition at line 476 of file SignalDesigner.cpp.

◆ OnSourceChanged()

void DynExpModule::SignalDesigner::OnSourceChanged ( DynExp::ModuleInstance Instance,
int  Index 
) const
private

Definition at line 469 of file SignalDesigner.cpp.

◆ OnStart()

void DynExpModule::SignalDesigner::OnStart ( DynExp::ModuleInstance Instance,
bool   
) const
private

Definition at line 604 of file SignalDesigner.cpp.

◆ OnStop()

void DynExpModule::SignalDesigner::OnStop ( DynExp::ModuleInstance Instance,
bool   
) const
private

Definition at line 611 of file SignalDesigner.cpp.

◆ OnStreamSizeChanged()

void DynExpModule::SignalDesigner::OnStreamSizeChanged ( DynExp::ModuleInstance Instance,
int  Value 
) const
private

Definition at line 494 of file SignalDesigner.cpp.

◆ OnTriggerEdgeChanged()

void DynExpModule::SignalDesigner::OnTriggerEdgeChanged ( DynExp::ModuleInstance Instance,
QString  Text 
) const
private

Definition at line 576 of file SignalDesigner.cpp.

◆ OnTriggerModeChanged()

void DynExpModule::SignalDesigner::OnTriggerModeChanged ( DynExp::ModuleInstance Instance,
QString  Text 
) const
private

Definition at line 560 of file SignalDesigner.cpp.

◆ ResetImpl()

void DynExpModule::SignalDesigner::ResetImpl ( dispatch_tag< QModuleBase )
finaloverrideprivate

Definition at line 352 of file SignalDesigner.cpp.

◆ UpdateUIChild()

void DynExpModule::SignalDesigner::UpdateUIChild ( const ModuleBase::ModuleDataGetterType &  ModuleDataGetter)
finaloverrideprivate

Definition at line 380 of file SignalDesigner.cpp.

◆ UpdateWaveform()

void DynExpModule::SignalDesigner::UpdateWaveform ( Util::SynchronizedPointer< SignalDesignerData > &  ModuleData,
bool  Autostart = false 
) const
private

Definition at line 430 of file SignalDesigner.cpp.


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