DynExp
Highly flexible laboratory automation for dynamically changing experiments.
Loading...
Searching...
No Matches
OutputPortWriter.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/OutputPort.h"
13
14#include <QWidget>
15
16namespace Ui
17{
18 class OutputPortWriter;
19}
20
21namespace DynExpModule
22{
23 class OutputPortWriter;
24
26 {
27 Q_OBJECT
28
29 public:
32
33 std::unique_ptr<Ui::OutputPortWriter> ui;
34 };
35
57
59 {
60 public:
62 virtual ~OutputPortWriterParams() = default;
63
64 virtual const char* GetParamClassTag() const noexcept override { return "OutputPortWriterParams"; }
65
67 "OutputPort", "Output port", "Underlying output port to be controlled by this module", DynExpUI::Icons::Instrument };
68
69 private:
71 };
72
74 {
75 public:
78
80 virtual ~OutputPortWriterConfigurator() = default;
81
82 private:
83 virtual DynExp::ParamsBasePtrType MakeParams(DynExp::ItemIDType ID, const DynExp::DynExpCore& Core) const override final { return DynExp::MakeParams<OutputPortWriterConfigurator>(ID, Core); }
84 };
85
87 {
88 public:
92
93 constexpr static auto Name() noexcept { return "Output Port Writer"; }
94 constexpr static auto Category() noexcept { return "I/O"; }
95
98 virtual ~OutputPortWriter() = default;
99
100 virtual std::string GetName() const override { return Name(); }
101 virtual std::string GetCategory() const override { return Category(); }
102
103 std::chrono::milliseconds GetMainLoopDelay() const override final { return std::chrono::milliseconds(50); }
104
105 private:
106 static constexpr auto DialControlValueDivider = 100;
107
109
110 void ResetImpl(dispatch_tag<QModuleBase>) override final;
111
112 std::unique_ptr<DynExp::QModuleWidget> MakeUIWidget() override final;
113 void UpdateUIChild(const ModuleBase::ModuleDataGetterType& ModuleDataGetter) override final;
114
115 // Events, run in module thread
116 void OnInit(DynExp::ModuleInstance* Instance) const override final;
117 void OnExit(DynExp::ModuleInstance* Instance) const override final;
118 void OnValueChanged(DynExp::ModuleInstance* Instance, int Value) const;
119 void OnStateButtonClicked(DynExp::ModuleInstance* Instance, bool Checked) const;
120 };
121}
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...
void ResetImpl(dispatch_tag< QModuleDataBase >) override final
virtual void ResetImpl(dispatch_tag< OutputPortWriterData >)
DynExp::LinkedObjectWrapperContainer< DynExpInstr::OutputPort > OutputPort
virtual ~OutputPortWriterData()=default
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...
void ConfigureParamsImpl(dispatch_tag< QModuleParamsBase >) override final
virtual ~OutputPortWriterParams()=default
OutputPortWriterParams(DynExp::ItemIDType ID, const DynExp::DynExpCore &Core)
Param< DynExp::ObjectLink< DynExpInstr::OutputPort > > OutputPort
std::unique_ptr< Ui::OutputPortWriter > ui
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...
virtual std::string GetCategory() const override
Returns the category of this Object type.
void OnStateButtonClicked(DynExp::ModuleInstance *Instance, bool Checked) const
void OnExit(DynExp::ModuleInstance *Instance) const override final
This event is triggered right before the module thread terminates (not due to an exception,...
static constexpr auto DialControlValueDivider
void OnValueChanged(DynExp::ModuleInstance *Instance, int Value) const
static constexpr auto Category() noexcept
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...
virtual ~OutputPortWriter()=default
virtual std::string GetName() const override
Returns the name of this Object type.
void UpdateUIChild(const ModuleBase::ModuleDataGetterType &ModuleDataGetter) override final
void ResetImpl(dispatch_tag< QModuleBase >) override final
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...
OutputPortWriter(const std::thread::id OwnerThreadID, DynExp::ParamsBasePtrType &&Params)
static constexpr auto Name() noexcept
std::chrono::milliseconds GetMainLoopDelay() const override final
Specifies in which time intervals the module's event queue runs to handle pending events.
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:3168
ModuleBase(const std::thread::id OwnerThreadID, ParamsBasePtrType &&Params)
Constructs a ModuleBase instance.
Definition Module.cpp:206
Refer to ParamsBase::dispatch_tag.
Definition Module.h:191
Defines data for a thread belonging to a ModuleBase instance. Refer to RunnableInstance.
Definition Module.h:840
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
Refer to ParamsBase::dispatch_tag.
Definition Object.h:2018
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:1660
QModuleBase(const std::thread::id OwnerThreadID, DynExp::ParamsBasePtrType &&Params)
Constructs a QModuleBase instance.
Definition Module.cpp:591
Configurator class for QModuleBase.
Definition Module.h:1646
Data class for QModuleBase.
Definition Module.h:1536
Parameter class for QModuleBase.
Definition Module.h:1622
QModuleParamsBase(ItemIDType ID, const DynExpCore &Core)
Constructs the parameters for a QModuleBase instance.
Definition Module.h:1628
Window class for Qt-based user interfaces belonging to DynExp modules. User interface Qt window class...
Definition Module.h:1395
QModuleBase & Owner
Module owning this user interface window (reference, because it should never change nor be nullptr).
Definition Module.h:1478
QModuleWidget(QModuleBase &Owner, QWidget *Parent=nullptr)
Constructs a QModuleWidget instance.
Definition Module.cpp:451
Wraps a member function of some object and stores its default arguments. Moving from CallableMemberWr...
Definition Util.h:448
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.