#include <ImageViewer.h>

Inheritance diagram for DynExpModule::ImageViewer::ImageViewer:

Classes
struct	AutofocusParamsType

struct	AutofocusResultsType

struct	AutofocusSampleType

Public Types
using	ParamsType = ImageViewerParams

using	ConfigType = ImageViewerConfigurator

using	ModuleDataType = ImageViewerData

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`. "

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`.

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`.

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`. "

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`.

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`.

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.

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.

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.

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`. "

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`.

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`.

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.

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.

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`.

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.

Public Member Functions
	ImageViewer (const std::thread::id OwnerThreadID, DynExp::ParamsBasePtrType &&Params)

virtual	~ImageViewer ()

virtual std::string	GetName () const override
	Returns the name of this `Object` type.

virtual std::string	GetCategory () const override
	Returns the category of this `Object` type.

std::chrono::milliseconds	GetMainLoopDelay () const override final
	Specifies in which time intervals the module's event queue runs to handle pending events.

void	OnSaveImage (DynExp::ModuleInstance *Instance, QString Filename) const

Public Member Functions inherited from DynExp::QModuleBase
	QModuleBase (const std::thread::id OwnerThreadID, DynExp::ParamsBasePtrType &&Params)
	Constructs a `QModuleBase` instance.

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.

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().

void	HideUI ()
	Removes MdiSubWindow, DockWidget, and ModuleWindowFocusAction setting them to `nullptr`.

void	DisableUI ()
	Disables all user interface controls in Widget. Does nothing if Widget is `nullptr`.

void	UpdateUI ()
	Enables the user interface controls in Widget. Does nothing if Widget is `nullptr`. Calls `UpdateUIChild()`.

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().

void	DockWindow () noexcept
	Docks Widget to MdiArea. Does nothing if any of Widget, MdiArea, MdiSubWindow, or DockWidget are `nullptr`.

void	UndockWindow () noexcept
	Undocks Widget from MdiArea. Does nothing if any of Widget, MdiArea, MdiSubWindow, or DockWidget are `nullptr`.

void	DockUndockWindow () noexcept
	Toggles the docking state of Widget. Does nothing if any of Widget, MdiArea, MdiSubWindow, or DockWidget are `nullptr`.

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`.

void	FocusMainWindow () noexcept
	Focuses/activates DynExp's main window calling DynExpManager::FocusMainWindow(). Does nothing if Widget is `nullptr`.

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`.

bool	IsWindowDocked () noexcept
	Checks whether Widget is docked.

bool	IsActiveWindow ()
	Checks whether Widget is docked and active.

Public Member Functions inherited from DynExp::ModuleBase
	ModuleBase (const std::thread::id OwnerThreadID, ParamsBasePtrType &&Params)
	Constructs a `ModuleBase` instance.

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.

void	UpdateParamsFromWindowStates ()
	`UpdateParamsFromWindowStates()` only calls `UpdateParamsFromWindowStatesChild()`. Override `UpdateParamsFromWindowStatesChild()` to store the styles of possibly owned windows in the module's parameters.

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.

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.

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.

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()).

virtual bool	TreatModuleExceptionsAsWarnings () const
	Determines whether this module should be terminated if an exception leaves the module's main loop or respective event handlers.

Public Member Functions inherited from DynExp::RunnableObject
	RunnableObject (const std::thread::id OwnerThreadID, ParamsBasePtrType &&Params)
	Constructs an `Object` instance.

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.

bool	IsRunning () const noexcept
	Returns Running.

bool	IsPaused () const noexcept
	Returns Paused.

bool	IsExiting () const noexcept
	Returns ShouldExit.

auto	GetStartupType () const noexcept
	Returns Startup.

auto	GetReasonWhyPaused () const
	Returns ReasonWhyPaused.

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()`.

bool	RunIfRunAutomatic ()
	Calls `Run()` if RunnableObjectParams::Startup is set to RunnableObjectParams::Automatic.

bool	RunIfRunOnCreation ()
	Calls `Run()` if RunnableObjectParams::Startup is set to RunnableObjectParams::OnCreation.

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().

Public Member Functions inherited from Util::INonCopyable
	INonCopyable (const INonCopyable &)=delete

INonCopyable &	operator= (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.

std::string	GetCategoryAndName () const
	Builds a string from an `Object's` category and name to allow the user to identify an `Object's` type.

void	EnsureReadyState (bool IsAutomaticStartup)
	Ensures that this `Object` instance is ready by possibly starting its worker thread or by opening connections to hardware devices.

void	CheckLinkedObjectStates () const
	Checks whether `Object` instances this instance uses are in a ready state. Override `CheckLinkedObjectStatesChild()` to implement this behavior.

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.

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.

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.

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.

auto	GetObjectName (const std::chrono::milliseconds Timeout=GetParamsTimeoutDefault) const
	Returns the name of this `Object` instance.

bool	IsSharedUsageEnabled (const std::chrono::milliseconds Timeout=GetParamsTimeoutDefault) const
	Returns whether shared usage has been enabled for this `Object` instance. Refer to ParamsBase::UsageType.

void	SetWarning (std::string Description, int ErrorCode) const
	Setter for Object::Warning. Sets the warning by a description and an error code.

void	SetWarning (const Util::Exception &e) const
	Setter for Object::Warning. Sets the warning by retrieving the warning data from an exception `e`.

void	ClearWarning () const
	Resets Object::Warning.

auto	GetWarning () const
	Returns Object::Warning in a thread-safe way by copying its internal data.

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.

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).

auto	GetUseCount (const std::chrono::milliseconds Timeout=Util::ILockable::DefaultTimeout) const
	Counts the registered useres in a thread-safe way.

bool	IsUnused (const std::chrono::milliseconds Timeout=Util::ILockable::DefaultTimeout) const
	Returns whether this `Object` instance is used by other instances.

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.

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.

Static Public Member Functions
static constexpr auto	Name () noexcept

static constexpr auto	Category () noexcept

Static Public Member Functions inherited from DynExp::ModuleBase
static constexpr auto	Category () noexcept
	Every derived class has to redefine this function.

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.

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()`.

void	ResetImpl (dispatch_tag< QModuleBase >) override final

std::unique_ptr< DynExp::QModuleWidget >	MakeUIWidget () 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.

void	UpdateUIChild (const ModuleBase::ModuleDataGetterType &ModuleDataGetter) override final

bool	IsReadyState () const

bool	IsAutofocusingState () const

void	FinishAutofocus (Util::SynchronizedPointer< ModuleDataType > &ModuleData, const FinishedAutofocusEvent &Event) 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()).

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()).

void	OnCameraModeChanged (DynExp::ModuleInstance *Instance, int Index) const

void	OnExposureTimeChanged (DynExp::ModuleInstance *Instance, int Value) const

void	OnCaptureSingle (DynExp::ModuleInstance *Instance, bool) const

void	OnCaptureContinuously (DynExp::ModuleInstance *Instance, bool Checked) const

void	OnPauseImageCapturing (DynExp::ModuleInstance *Instance, bool ResetImageTransformation=false) const

void	OnResumeImageCapturing (DynExp::ModuleInstance *Instance) const

void	OnAutofocusClicked (DynExp::ModuleInstance *Instance, bool Checked) const

void	OnAutofocus (DynExp::ModuleInstance *Instance, bool ResetImageTransformation=false) const

StateType	ReadyStateFunc (DynExp::ModuleInstance &Instance)

StateType	AutofocusInitStateFunc (DynExp::ModuleInstance &Instance)

StateType	AutofocusGotoSampleStateFunc (DynExp::ModuleInstance &Instance)

StateType	AutofocusWaitBeforeCaptureStateFunc (DynExp::ModuleInstance &Instance)

StateType	AutofocusWaitForImageStateFunc (DynExp::ModuleInstance &Instance)

StateType	AutofocusStepStateFunc (DynExp::ModuleInstance &Instance)

StateType	AutofocusFinishedStateFunc (DynExp::ModuleInstance &Instance)

Private Attributes
Util::StateMachine< StateMachineStateType >	StateMachine

AutofocusParamsType	AutofocusParams

AutofocusResultsType	AutofocusResults

bool	AutofocusIsPerformingFineSweep = false

std::vector< AutofocusSampleType >	AutofocusSamples

std::vector< AutofocusSampleType >::iterator	AutofocusCurrentSample

std::chrono::system_clock::time_point	AutofocusWaitingEndTimePoint

const std::shared_ptr< std::atomic< bool > >	PauseUpdatingUI

size_t	NumFailedUpdateAttempts = 0

Static Private Attributes
static constexpr auto	ReadyState

static constexpr auto	AutofocusInitState

static constexpr auto	AutofocusGotoSampleState

static constexpr auto	AutofocusWaitBeforeCaptureState

static constexpr auto	AutofocusWaitForImageState

static constexpr auto	AutofocusStepState

static constexpr auto	AutofocusFinishedState

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()`.

EventListenersOnlyType	EventListenersOnly
	Allow exclusive access to some of `ModuleBase's` private methods to any `TypedEventListeners` class.

Public Attributes inherited from DynExp::RunnableObject
RunnableInstanceOnlyType	RunnableInstanceOnly
	Allow exclusive access to some of `RunnableObject's` private methods to class `RunnableInstance`.

Public Attributes inherited from DynExp::Object
LinkedObjectWrapperOnlyType	LinkedObjectWrapperOnly
	Allow exclusive access to some of `Object's` private methods to any LinkedObjectWrapper<T>.

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.

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.

static constexpr auto	TerminateTimeoutDefault = std::chrono::milliseconds(3000)
	Default timeout used as a default for calls to RunnableObject::Terminate.

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.

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.

template<typename WidgetType >
WidgetType *	GetWidget () const
	Getter for Widget.

Protected Member Functions inherited from DynExp::RunnableObject
void	Init ()
	Initializes member variables in case of a reset.

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.

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()!`

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`.

void	EnsureCallFromRunnableThread () const
	Asserts that the call to this function is performed from the `RunnableObject` instance's thread by calling IsCallFromRunnableThread().

void	SetReasonWhyPaused (std::string Description)
	Sets the reason why this `RunnableObject` instance has been paused.

void	SetReasonWhyPaused (const Util::Exception &e)
	Sets the reason why this `RunnableObject` instance has been paused.

void	ClearReasonWhyPaused ()
	Removes the reason why this `RunnableObject` instance has been paused (since it is resumed).

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.

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).

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).

auto	LockUserList (const std::chrono::milliseconds Timeout=Util::ILockable::DefaultTimeout)
	Locks the user list for thread-safe manipulation.

void	DeregisterAllUnsafe ()
	Deregisters all users and notifies them that they need to check the states of their used linked objects.

auto	GetUseCountUnsafe ()

auto	GetUserNamesStringUnsafe () const

bool	IsUnusedUnsafe ()
	Returns whether this `Object` instance is used by other instances (not thread-safe).

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.

Detailed Description

Definition at line 177 of file ImageViewer.h.

Class Documentation

◆ DynExpModule::ImageViewer::ImageViewer::AutofocusResultsType

struct DynExpModule::ImageViewer::ImageViewer::AutofocusResultsType

Definition at line 225 of file ImageViewer.h.

Class Members
double	FocusVoltage = std::numeric_limits<double>::quiet_NaN()
bool	Success = false

◆ DynExpModule::ImageViewer::ImageViewer::AutofocusSampleType

struct DynExpModule::ImageViewer::ImageViewer::AutofocusSampleType

Definition at line 231 of file ImageViewer.h.

Class Members
double	Result {}
double	Voltage {}

Member Typedef Documentation

◆ ConfigType

using DynExpModule::ImageViewer::ImageViewer::ConfigType = ImageViewerConfigurator

Definition at line 181 of file ImageViewer.h.

◆ ModuleDataType

using DynExpModule::ImageViewer::ImageViewer::ModuleDataType = ImageViewerData

Definition at line 182 of file ImageViewer.h.

◆ ParamsType

using DynExpModule::ImageViewer::ImageViewer::ParamsType = ImageViewerParams

Definition at line 180 of file ImageViewer.h.

Constructor & Destructor Documentation

◆ ImageViewer()

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

Definition at line 329 of file ImageViewer.cpp.

◆ ~ImageViewer()

DynExpModule::ImageViewer::ImageViewer::~ImageViewer ( )

virtual

Definition at line 338 of file ImageViewer.cpp.

Member Function Documentation

◆ AutofocusFinishedStateFunc()

StateType DynExpModule::ImageViewer::ImageViewer::AutofocusFinishedStateFunc ( DynExp::ModuleInstance & Instance )

private

Definition at line 860 of file ImageViewer.cpp.

◆ AutofocusGotoSampleStateFunc()

StateType DynExpModule::ImageViewer::ImageViewer::AutofocusGotoSampleStateFunc ( DynExp::ModuleInstance & Instance )

private

Definition at line 776 of file ImageViewer.cpp.

◆ AutofocusInitStateFunc()

StateType DynExpModule::ImageViewer::ImageViewer::AutofocusInitStateFunc ( DynExp::ModuleInstance & Instance )

private

Definition at line 756 of file ImageViewer.cpp.

◆ AutofocusStepStateFunc()

StateType DynExpModule::ImageViewer::ImageViewer::AutofocusStepStateFunc ( DynExp::ModuleInstance & Instance )

private

Definition at line 830 of file ImageViewer.cpp.

◆ AutofocusWaitBeforeCaptureStateFunc()

StateType DynExpModule::ImageViewer::ImageViewer::AutofocusWaitBeforeCaptureStateFunc ( DynExp::ModuleInstance & Instance )

private

Definition at line 791 of file ImageViewer.cpp.

◆ AutofocusWaitForImageStateFunc()

StateType DynExpModule::ImageViewer::ImageViewer::AutofocusWaitForImageStateFunc ( DynExp::ModuleInstance & Instance )

private

Definition at line 807 of file ImageViewer.cpp.

◆ Category()

static constexpr auto DynExpModule::ImageViewer::ImageViewer::Category ( )

inlinestaticconstexprnoexcept

Definition at line 185 of file ImageViewer.h.

◆ FinishAutofocus()

void DynExpModule::ImageViewer::ImageViewer::FinishAutofocus	(	Util::SynchronizedPointer< ModuleDataType > &	ModuleData,
		const FinishedAutofocusEvent &	Event
	)		const

private

Definition at line 535 of file ImageViewer.cpp.

◆ GetCategory()

virtual std::string DynExpModule::ImageViewer::ImageViewer::GetCategory ( ) const

inlineoverridevirtual

Returns the category of this Object type.

Reimplemented from DynExp::ModuleBase.

Definition at line 191 of file ImageViewer.h.

◆ GetMainLoopDelay()

std::chrono::milliseconds DynExpModule::ImageViewer::ImageViewer::GetMainLoopDelay ( ) const

inlinefinaloverridevirtual

Specifies in which time intervals the module's event queue runs to handle pending events.

Returns: Delay time in between event queue executions. Return std::chrono::milliseconds::max() to make the module thread only wake up to execute the module main loop (after handling enqueued events) when an event is enqueued. Return 0 to make the module main loop execute as fast as possible.

Reimplemented from DynExp::ModuleBase.

Definition at line 194 of file ImageViewer.h.

◆ GetName()

virtual std::string DynExpModule::ImageViewer::ImageViewer::GetName ( ) const

inlineoverridevirtual

Returns the name of this Object type.

Implements DynExp::Object.

Definition at line 190 of file ImageViewer.h.

◆ IsAutofocusingState()

bool DynExpModule::ImageViewer::ImageViewer::IsAutofocusingState ( ) const

private

Definition at line 523 of file ImageViewer.cpp.

◆ IsReadyState()

bool DynExpModule::ImageViewer::ImageViewer::IsReadyState ( ) const

private

Definition at line 516 of file ImageViewer.cpp.

◆ MakeUIWidget()

std::unique_ptr< DynExp::QModuleWidget > DynExpModule::ImageViewer::ImageViewer::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 385 of file ImageViewer.cpp.

◆ ModuleMainLoop()

Util::DynExpErrorCodes::DynExpErrorCodes DynExpModule::ImageViewer::ImageViewer::ModuleMainLoop ( DynExp::ModuleInstance & Instance )

finaloverrideprivatevirtual

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

Parameters

Instance Handle 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 354 of file ImageViewer.cpp.

◆ Name()

static constexpr auto DynExpModule::ImageViewer::ImageViewer::Name ( )

inlinestaticconstexprnoexcept

Definition at line 184 of file ImageViewer.h.

◆ OnAutofocus()

void DynExpModule::ImageViewer::ImageViewer::OnAutofocus	(	DynExp::ModuleInstance *	Instance,
		bool	ResetImageTransformation = `false`
	)		const

private

Definition at line 692 of file ImageViewer.cpp.

◆ OnAutofocusClicked()

void DynExpModule::ImageViewer::ImageViewer::OnAutofocusClicked	(	DynExp::ModuleInstance *	Instance,
		bool	Checked
	)		const

private

Definition at line 674 of file ImageViewer.cpp.

◆ OnCameraModeChanged()

void DynExpModule::ImageViewer::ImageViewer::OnCameraModeChanged	(	DynExp::ModuleInstance *	Instance,
		int	Index
	)		const

private

Definition at line 581 of file ImageViewer.cpp.

◆ OnCaptureContinuously()

void DynExpModule::ImageViewer::ImageViewer::OnCaptureContinuously	(	DynExp::ModuleInstance *	Instance,
		bool	Checked
	)		const

private

Definition at line 629 of file ImageViewer.cpp.

◆ OnCaptureSingle()

void DynExpModule::ImageViewer::ImageViewer::OnCaptureSingle	(	DynExp::ModuleInstance *	Instance,
		bool
	)		const

private

Definition at line 620 of file ImageViewer.cpp.

◆ OnExit()

void DynExpModule::ImageViewer::ImageViewer::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

Instance Handle to the module thread's data

Reimplemented from DynExp::ModuleBase.

Definition at line 568 of file ImageViewer.cpp.

◆ OnExposureTimeChanged()

void DynExpModule::ImageViewer::ImageViewer::OnExposureTimeChanged	(	DynExp::ModuleInstance *	Instance,
		int	Value
	)		const

private

Definition at line 596 of file ImageViewer.cpp.

◆ OnInit()

void DynExpModule::ImageViewer::ImageViewer::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

Instance Handle to the module thread's data

Reimplemented from DynExp::ModuleBase.

Definition at line 544 of file ImageViewer.cpp.

◆ OnPauseImageCapturing()

void DynExpModule::ImageViewer::ImageViewer::OnPauseImageCapturing	(	DynExp::ModuleInstance *	Instance,
		bool	ResetImageTransformation = `false`
	)		const

private

Definition at line 641 of file ImageViewer.cpp.

◆ OnResumeImageCapturing()

void DynExpModule::ImageViewer::ImageViewer::OnResumeImageCapturing ( DynExp::ModuleInstance * Instance ) const

private

Definition at line 659 of file ImageViewer.cpp.

◆ OnSaveImage()

void DynExpModule::ImageViewer::ImageViewer::OnSaveImage	(	DynExp::ModuleInstance *	Instance,
		QString	Filename
	)		const

Definition at line 342 of file ImageViewer.cpp.

◆ ReadyStateFunc()

StateType DynExpModule::ImageViewer::ImageViewer::ReadyStateFunc ( DynExp::ModuleInstance & Instance )

private

Definition at line 725 of file ImageViewer.cpp.

◆ ResetImpl()

void DynExpModule::ImageViewer::ImageViewer::ResetImpl ( dispatch_tag< QModuleBase > )

finaloverrideprivate

Definition at line 371 of file ImageViewer.cpp.

◆ UpdateUIChild()

void DynExpModule::ImageViewer::ImageViewer::UpdateUIChild ( const ModuleBase::ModuleDataGetterType & ModuleDataGetter )

finaloverrideprivate

Definition at line 398 of file ImageViewer.cpp.

Member Data Documentation

◆ AutofocusCurrentSample

std::vector<AutofocusSampleType>::iterator DynExpModule::ImageViewer::ImageViewer::AutofocusCurrentSample

private

Definition at line 283 of file ImageViewer.h.

◆ AutofocusFinishedState

constexpr auto DynExpModule::ImageViewer::ImageViewer::AutofocusFinishedState

staticconstexprprivate

Initial value:

= Util::StateMachineState(StateType::AutofocusFinished,

&ImageViewer::AutofocusFinishedStateFunc, "Autofocusing...")

DynExpModule::ImageViewer::ImageViewer::AutofocusFinishedStateFunc

StateType AutofocusFinishedStateFunc(DynExp::ModuleInstance &Instance)

Definition ImageViewer.cpp:860

Util::StateMachineState

State machine state as used by class StateMachine. A state mainly wraps a state function of the membe...

Definition Util.h:1305

DynExpModule::ImageViewer::StateType::AutofocusFinished

@ AutofocusFinished

Definition at line 272 of file ImageViewer.h.

◆ AutofocusGotoSampleState

constexpr auto DynExpModule::ImageViewer::ImageViewer::AutofocusGotoSampleState

staticconstexprprivate

Initial value:

= Util::StateMachineState(StateType::AutofocusGotoSample,

&ImageViewer::AutofocusGotoSampleStateFunc, "Autofocusing...")

DynExpModule::ImageViewer::ImageViewer::AutofocusGotoSampleStateFunc

StateType AutofocusGotoSampleStateFunc(DynExp::ModuleInstance &Instance)

Definition ImageViewer.cpp:776

DynExpModule::ImageViewer::StateType::AutofocusGotoSample

@ AutofocusGotoSample

Definition at line 264 of file ImageViewer.h.

◆ AutofocusInitState

constexpr auto DynExpModule::ImageViewer::ImageViewer::AutofocusInitState

staticconstexprprivate

Initial value:

= Util::StateMachineState(StateType::AutofocusInit,

&ImageViewer::AutofocusInitStateFunc, "Autofocusing...")

DynExpModule::ImageViewer::ImageViewer::AutofocusInitStateFunc

StateType AutofocusInitStateFunc(DynExp::ModuleInstance &Instance)

Definition ImageViewer.cpp:756

DynExpModule::ImageViewer::StateType::AutofocusInit

@ AutofocusInit

Definition at line 262 of file ImageViewer.h.

◆ AutofocusIsPerformingFineSweep

bool DynExpModule::ImageViewer::ImageViewer::AutofocusIsPerformingFineSweep = false

private

Definition at line 281 of file ImageViewer.h.

◆ AutofocusParams

AutofocusParamsType DynExpModule::ImageViewer::ImageViewer::AutofocusParams

mutableprivate

Definition at line 279 of file ImageViewer.h.

◆ AutofocusResults

AutofocusResultsType DynExpModule::ImageViewer::ImageViewer::AutofocusResults

private

Definition at line 280 of file ImageViewer.h.

◆ AutofocusSamples

std::vector<AutofocusSampleType> DynExpModule::ImageViewer::ImageViewer::AutofocusSamples

private

Definition at line 282 of file ImageViewer.h.

◆ AutofocusStepState

constexpr auto DynExpModule::ImageViewer::ImageViewer::AutofocusStepState

staticconstexprprivate

Initial value:

= Util::StateMachineState(StateType::AutofocusStep,

&ImageViewer::AutofocusStepStateFunc, "Autofocusing...")

DynExpModule::ImageViewer::ImageViewer::AutofocusStepStateFunc

StateType AutofocusStepStateFunc(DynExp::ModuleInstance &Instance)

Definition ImageViewer.cpp:830

DynExpModule::ImageViewer::StateType::AutofocusStep

@ AutofocusStep

Definition at line 270 of file ImageViewer.h.

◆ AutofocusWaitBeforeCaptureState

constexpr auto DynExpModule::ImageViewer::ImageViewer::AutofocusWaitBeforeCaptureState

staticconstexprprivate

Initial value:

= Util::StateMachineState(StateType::AutofocusWaitBeforeCapture,

&ImageViewer::AutofocusWaitBeforeCaptureStateFunc, "Autofocusing...")

DynExpModule::ImageViewer::ImageViewer::AutofocusWaitBeforeCaptureStateFunc

StateType AutofocusWaitBeforeCaptureStateFunc(DynExp::ModuleInstance &Instance)

Definition ImageViewer.cpp:791

DynExpModule::ImageViewer::StateType::AutofocusWaitBeforeCapture

@ AutofocusWaitBeforeCapture

Definition at line 266 of file ImageViewer.h.

◆ AutofocusWaitForImageState

constexpr auto DynExpModule::ImageViewer::ImageViewer::AutofocusWaitForImageState

staticconstexprprivate

Initial value:

= Util::StateMachineState(StateType::AutofocusWaitForImage,

&ImageViewer::AutofocusWaitForImageStateFunc, "Autofocusing...")

DynExpModule::ImageViewer::ImageViewer::AutofocusWaitForImageStateFunc

StateType AutofocusWaitForImageStateFunc(DynExp::ModuleInstance &Instance)

Definition ImageViewer.cpp:807

DynExpModule::ImageViewer::StateType::AutofocusWaitForImage

@ AutofocusWaitForImage

Definition at line 268 of file ImageViewer.h.

◆ AutofocusWaitingEndTimePoint

std::chrono::system_clock::time_point DynExpModule::ImageViewer::ImageViewer::AutofocusWaitingEndTimePoint

private

Definition at line 284 of file ImageViewer.h.

◆ NumFailedUpdateAttempts

size_t DynExpModule::ImageViewer::ImageViewer::NumFailedUpdateAttempts = 0

private

Definition at line 287 of file ImageViewer.h.

◆ PauseUpdatingUI

const std::shared_ptr<std::atomic<bool> > DynExpModule::ImageViewer::ImageViewer::PauseUpdatingUI

private

Definition at line 286 of file ImageViewer.h.

◆ ReadyState

constexpr auto DynExpModule::ImageViewer::ImageViewer::ReadyState

staticconstexprprivate

Initial value:

= Util::StateMachineState(StateType::Ready,

&ImageViewer::ReadyStateFunc, "Ready")

DynExpModule::ImageViewer::ImageViewer::ReadyStateFunc

StateType ReadyStateFunc(DynExp::ModuleInstance &Instance)

Definition ImageViewer.cpp:725

DynExpModule::ImageViewer::StateType::Ready

@ Ready

Definition at line 260 of file ImageViewer.h.

◆ StateMachine

Util::StateMachine<StateMachineStateType> DynExpModule::ImageViewer::ImageViewer::StateMachine

mutableprivate

Definition at line 276 of file ImageViewer.h.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Class Documentation

◆ DynExpModule::ImageViewer::ImageViewer::AutofocusResultsType

◆ DynExpModule::ImageViewer::ImageViewer::AutofocusSampleType

Member Typedef Documentation

◆ ConfigType

◆ ModuleDataType

◆ ParamsType

Constructor & Destructor Documentation

◆ ImageViewer()

◆ ~ImageViewer()

Member Function Documentation

◆ AutofocusFinishedStateFunc()

◆ AutofocusGotoSampleStateFunc()

◆ AutofocusInitStateFunc()

◆ AutofocusStepStateFunc()

◆ AutofocusWaitBeforeCaptureStateFunc()

◆ AutofocusWaitForImageStateFunc()

◆ Category()

◆ FinishAutofocus()

◆ GetCategory()

◆ GetMainLoopDelay()

◆ GetName()

◆ IsAutofocusingState()

◆ IsReadyState()

◆ MakeUIWidget()

◆ ModuleMainLoop()

◆ Name()

◆ OnAutofocus()

◆ OnAutofocusClicked()

◆ OnCameraModeChanged()

◆ OnCaptureContinuously()

◆ OnCaptureSingle()

◆ OnExit()

◆ OnExposureTimeChanged()

◆ OnInit()

◆ OnPauseImageCapturing()

◆ OnResumeImageCapturing()

◆ OnSaveImage()

◆ ReadyStateFunc()

◆ ResetImpl()

◆ UpdateUIChild()

Member Data Documentation

◆ AutofocusCurrentSample

◆ AutofocusFinishedState

◆ AutofocusGotoSampleState

◆ AutofocusInitState

◆ AutofocusIsPerformingFineSweep

◆ AutofocusParams

◆ AutofocusResults

◆ AutofocusSamples

◆ AutofocusStepState

◆ AutofocusWaitBeforeCaptureState

◆ AutofocusWaitForImageState

◆ AutofocusWaitingEndTimePoint

◆ NumFailedUpdateAttempts

◆ PauseUpdatingUI

◆ ReadyState

◆ StateMachine