DynExp
Highly flexible laboratory automation for dynamically changing experiments.
Loading...
Searching...
No Matches
Stage1D.h
Go to the documentation of this file.
1// This file is part of DynExp.
2
8#pragma once
9
10#include "stdafx.h"
11#include "DynExpCore.h"
12#include "../MetaInstruments/Stage.h"
13
14#include <QWidget>
15#include "ui_Stage1D.h"
16
17namespace DynExpModule
18{
19 class Stage1D;
20
22 {
23 Q_OBJECT
24
25 public:
26 Stage1DWidget(Stage1D& Owner, QModuleWidget* parent = nullptr);
27 ~Stage1DWidget() = default;
28
29 Ui::Stage1D ui;
30 };
31
53
55 {
56 public:
58 virtual ~Stage1DParams() = default;
59
60 virtual const char* GetParamClassTag() const noexcept override { return "Stage1DParams"; }
61
63 "PositionerStage", "Positioner", "Underlying positioner to be controlled by this module", DynExpUI::Icons::Instrument };
64
65 private:
67 };
68
70 {
71 public:
74
76 virtual ~Stage1DConfigurator() = default;
77
78 private:
79 virtual DynExp::ParamsBasePtrType MakeParams(DynExp::ItemIDType ID, const DynExp::DynExpCore& Core) const override final { return DynExp::MakeParams<Stage1DConfigurator>(ID, Core); }
80 };
81
83 {
84 public:
88
89 constexpr static auto Name() noexcept { return "1D Positioner Control"; }
90 constexpr static auto Category() noexcept { return "Motion Control"; }
91
94 virtual ~Stage1D() = default;
95
96 virtual std::string GetName() const override { return Name(); }
97 virtual std::string GetCategory() const override { return Category(); }
98
99 std::chrono::milliseconds GetMainLoopDelay() const override final { return std::chrono::milliseconds(20); }
100
101 private:
103
104 void ResetImpl(dispatch_tag<QModuleBase>) override final;
105
106 std::unique_ptr<DynExp::QModuleWidget> MakeUIWidget() override final;
107 void UpdateUIChild(const ModuleBase::ModuleDataGetterType& ModuleDataGetter) override final;
108
109 // Events, run in module thread
110 void OnInit(DynExp::ModuleInstance* Instance) const override final;
111 void OnExit(DynExp::ModuleInstance* Instance) const override final;
112 void OnFindReferenceClicked(DynExp::ModuleInstance* Instance, bool) const;
113 void OnSetHomeClicked(DynExp::ModuleInstance* Instance, bool) const;
114 void OnCalibrateClicked(DynExp::ModuleInstance* Instance, bool) const;
115 void OnMoveFirstClicked(DynExp::ModuleInstance* Instance, bool) const;
116 void OnMoveLastClicked(DynExp::ModuleInstance* Instance, bool) const;
117 void OnMoveLeftClicked(DynExp::ModuleInstance* Instance, bool) const;
118 void OnMoveRightClicked(DynExp::ModuleInstance* Instance, bool) const;
119 void OnMoveHomeClicked(DynExp::ModuleInstance* Instance, bool) const;
120 void OnStopClicked(DynExp::ModuleInstance* Instance, bool) const;
121 void OnVelocityValueChanged(DynExp::ModuleInstance* Instance, const double Value) const;
122 void OnPositionValueChanged(DynExp::ModuleInstance* Instance, const double Value) const;
123
125 };
126}
Defines DynExp's core module as an interface between the UI and DynExp objects.
virtual DynExp::ParamsBasePtrType MakeParams(DynExp::ItemIDType ID, const DynExp::DynExpCore &Core) const override final
Override to make derived classes call DynExp::MakeParams with the correct configurator type derived f...
Definition Stage1D.h:79
virtual ~Stage1DConfigurator()=default
void ResetImpl(dispatch_tag< QModuleDataBase >) override final
Definition Stage1D.cpp:18
virtual ~Stage1DData()=default
virtual void ResetImpl(dispatch_tag< Stage1DData >)
Definition Stage1D.h:49
DynExp::LinkedObjectWrapperContainer< DynExpInstr::PositionerStage > PositionerStage
Definition Stage1D.h:38
Param< DynExp::ObjectLink< DynExpInstr::PositionerStage > > PositionerStage
Definition Stage1D.h:62
virtual const char * GetParamClassTag() const noexcept override
This function is intended to be overridden once in each derived class returning the name of the respe...
Definition Stage1D.h:60
virtual ~Stage1DParams()=default
void ConfigureParamsImpl(dispatch_tag< QModuleParamsBase >) override final
Definition Stage1D.h:66
Stage1DParams(DynExp::ItemIDType ID, const DynExp::DynExpCore &Core)
Definition Stage1D.h:57
void UpdateUIChild(const ModuleBase::ModuleDataGetterType &ModuleDataGetter) override final
Definition Stage1D.cpp:82
void OnSetHomeClicked(DynExp::ModuleInstance *Instance, bool) const
Definition Stage1D.cpp:140
static constexpr auto Name() noexcept
Definition Stage1D.h:89
static constexpr auto Category() noexcept
Definition Stage1D.h:90
void ResetImpl(dispatch_tag< QModuleBase >) override final
Definition Stage1D.cpp:57
void OnMoveFirstClicked(DynExp::ModuleInstance *Instance, bool) const
Definition Stage1D.cpp:152
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...
Definition Stage1D.cpp:62
Stage1D(const std::thread::id OwnerThreadID, DynExp::ParamsBasePtrType &&Params)
Definition Stage1D.h:92
void OnVelocityValueChanged(DynExp::ModuleInstance *Instance, const double Value) const
Definition Stage1D.cpp:188
virtual ~Stage1D()=default
void OnMoveLastClicked(DynExp::ModuleInstance *Instance, bool) const
Definition Stage1D.cpp:158
void OnCalibrateClicked(DynExp::ModuleInstance *Instance, bool) const
Definition Stage1D.cpp:146
void OnFindReferenceClicked(DynExp::ModuleInstance *Instance, bool) const
Definition Stage1D.cpp:134
std::chrono::milliseconds GetMainLoopDelay() const override final
Specifies in which time intervals the module's event queue runs to handle pending events.
Definition Stage1D.h:99
void OnStopClicked(DynExp::ModuleInstance *Instance, bool) const
Definition Stage1D.cpp:182
void OnMoveRightClicked(DynExp::ModuleInstance *Instance, bool) const
Definition Stage1D.cpp:170
virtual std::string GetName() const override
Returns the name of this Object type.
Definition Stage1D.h:96
void OnInit(DynExp::ModuleInstance *Instance) const override final
This event is triggered right before the module thread starts. Override it to lock instruments this m...
Definition Stage1D.cpp:119
void OnExit(DynExp::ModuleInstance *Instance) const override final
This event is triggered right before the module thread terminates (not due to an exception,...
Definition Stage1D.cpp:127
Util::DynExpErrorCodes::DynExpErrorCodes ModuleMainLoop(DynExp::ModuleInstance &Instance) override final
Module main loop. The function is executed periodically by the module thread. Also refer to GetMainLo...
Definition Stage1D.cpp:33
void OnMoveLeftClicked(DynExp::ModuleInstance *Instance, bool) const
Definition Stage1D.cpp:164
void OnPositionValueChanged(DynExp::ModuleInstance *Instance, const double Value) const
Definition Stage1D.cpp:194
virtual std::string GetCategory() const override
Returns the category of this Object type.
Definition Stage1D.h:97
size_t NumFailedUpdateAttempts
Definition Stage1D.h:124
void OnMoveHomeClicked(DynExp::ModuleInstance *Instance, bool) const
Definition Stage1D.cpp:176
DynExp's core class acts as the interface between the user interface and DynExp's internal data like ...
Definition DynExpCore.h:127
This class holds a pointer (LinkedObjectWrapperPointer) to a LinkedObjectWrapper. Intances of this cl...
Definition Object.h:3160
Util::CallableMemberWrapper< ModuleBase, ModuleDataTypeSyncPtrType(ModuleBase::*)(const std::chrono::milliseconds)> ModuleDataGetterType
Invoking an instance of this alias is supposed to call ModuleBase::GetModuleData() of the instance th...
Definition Module.h:587
ModuleBase(const std::thread::id OwnerThreadID, ParamsBasePtrType &&Params)
Constructs a ModuleBase instance.
Definition Module.cpp:189
Refer to ParamsBase::dispatch_tag.
Definition Module.h:189
Defines data for a thread belonging to a ModuleBase instance. Refer to RunnableInstance.
Definition Module.h:793
const std::thread::id OwnerThreadID
Thread id of the thread which has constructed (and owns) this Object instance.
Definition Object.h:2302
const ParamsBasePtrType Params
Pointer to the parameter class instance belonging to this Object instance.
Definition Object.h:2303
const auto & GetCore() const noexcept
Returns a reference to DynExp's core.
Definition Object.h:1677
const ItemIDType ID
ID of the Object this parameter class instance belongs to.
Definition Object.h:1779
const DynExpCore & Core
Reference to DynExp's core.
Definition Object.h:1780
Tag for function dispatching mechanism within this class used when derived classes are not intended t...
Definition Object.h:349
Base class for modules with a Qt-based user interface. Derive from this class to implement modules wi...
Definition Module.h:1344
QModuleBase(const std::thread::id OwnerThreadID, DynExp::ParamsBasePtrType &&Params)
Constructs a QModuleBase instance.
Definition Module.cpp:557
Configurator class for QModuleBase.
Definition Module.h:1330
Data class for QModuleBase.
Definition Module.h:1220
Parameter class for QModuleBase.
Definition Module.h:1306
QModuleParamsBase(ItemIDType ID, const DynExpCore &Core)
Constructs the parameters for a QModuleBase instance.
Definition Module.h:1312
Window class for Qt-based user interfaces belonging to DynExp modules. User interface Qt window class...
Definition Module.h:1079
QModuleBase & Owner
Module owning this user interface window (reference, because it should never change nor be nullptr).
Definition Module.h:1162
QModuleWidget(QModuleBase &Owner, QWidget *Parent=nullptr)
Constructs a QModuleWidget instance.
Definition Module.cpp:417
DynExp's module namespace contains the implementation of DynExp modules which extend DynExp's core fu...
constexpr auto Instrument
DynExp's main namespace contains the implementation of DynExp including classes to manage resources (...
std::unique_ptr< ParamsBase > ParamsBasePtrType
Alias for a pointer to the parameter system base class ParamsBase.
Definition Object.h:1807
size_t ItemIDType
ID type of objects/items managed by DynExp.
DynExpErrorCodes
DynExp's error codes
Definition Exception.h:22
Accumulates include statements to provide a precompiled header.