|
| | ImageViewer (const std::thread::id OwnerThreadID, DynExp::ParamsBasePtrType &&Params) |
| |
| virtual | ~ImageViewer () |
| |
| 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...
|
| |
| std::chrono::milliseconds | GetMainLoopDelay () const override final |
| | Specifies in which time intervals the module's event queue runs to handle pending events. More...
|
| |
| void | OnSaveImage (DynExp::ModuleInstance *Instance, QString Filename) const |
| |
| | 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...
|
| |
| | 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...
|
| |
| | 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...
|
| |
| | INonCopyable (const INonCopyable &)=delete |
| |
| INonCopyable & | operator= (const INonCopyable &)=delete |
| |
| 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...
|
| |
|
| 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...
|
| |
| RunnableInstanceOnlyType | RunnableInstanceOnly |
| | Allow exclusive access to some of RunnableObject's private methods to class RunnableInstance. More...
|
| |
| LinkedObjectWrapperOnlyType | LinkedObjectWrapperOnly |
| | Allow exclusive access to some of Object's private methods to any LinkedObjectWrapper<T>. More...
|
| |
| 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 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 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...
|
| |
| 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...
|
| |
| 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...
|
| |
| constexpr | INonCopyable ()=default |
| |
| | ~INonCopyable ()=default |
| |
| | 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 auto | GetExceptionUnsafe (const ModuleDataTypeSyncPtrConstType &ModuleDataPtr) |
| | Getter for ModuleDataBase::ModuleException assuming that the module data has already been locked. More...
|
| |
Inheritance diagram for DynExpModule::ImageViewer::ImageViewer:
1.9.1