DynExp
Highly flexible laboratory automation for dynamically changing experiments.
NetworkAnalogInModule.h
Go to the documentation of this file.
1 // This file is part of DynExp.
2 
9 #pragma once
10 
11 #include "stdafx.h"
12 #include "../MetaInstruments/AnalogIn.h"
14 
15 #include "NetworkAnalogIn.grpc.pb.h"
16 
17 namespace DynExpModule
18 {
19  template <typename... gRPCServices>
20  class NetworkAnalogInT;
21 
22  template <typename... gRPCServices>
23  class NetworkAnalogInData : public NetworkDataStreamInstrumentData<gRPCServices...>
24  {
25  public:
27 
29  virtual ~NetworkAnalogInData() = default;
30 
31  auto GetAnalogIn() { return DynExp::dynamic_Object_cast<InstrType>(NetworkDataStreamInstrumentData<gRPCServices...>::GetDataStreamInstrument().get()); }
32 
33  private:
36 
37  void Init() {}
38  };
39 
40  template <typename... gRPCServices>
42  {
43  public:
45  virtual ~NetworkAnalogInParams() = default;
46 
47  virtual const char* GetParamClassTag() const noexcept override { return "NetworkAnalogInParams"; }
48 
49  private:
52 
54  };
55 
56  template <typename... gRPCServices>
58  {
59  public:
60  using ObjectType = NetworkAnalogInT<gRPCServices...>;
61  using ParamsType = NetworkAnalogInParams<gRPCServices...>;
62 
64  virtual ~NetworkAnalogInConfigurator() = default;
65 
66  private:
67  virtual DynExp::ParamsBasePtrType MakeParams(DynExp::ItemIDType ID, const DynExp::DynExpCore& Core) const override { return DynExp::MakeParams<NetworkAnalogInConfigurator>(ID, Core); }
68  };
69 
70  template <typename... gRPCServices>
71  class NetworkAnalogInT : public NetworkDataStreamInstrumentT<gRPCServices...>
72  {
73  public:
74  using ParamsType = NetworkAnalogInParams<gRPCServices...>;
75  using ConfigType = NetworkAnalogInConfigurator<gRPCServices...>;
76  using ModuleDataType = NetworkAnalogInData<gRPCServices...>;
78 
79  constexpr static auto Name() noexcept { return "Network Analog In"; }
80 
82  : NetworkDataStreamInstrumentT<gRPCServices...>(OwnerThreadID, std::move(Params)) {}
83  virtual ~NetworkAnalogInT() = default;
84 
85  virtual std::string GetName() const override { return Name(); }
86 
87  protected:
89  : public gRPCModule<gRPCServices...>::template TypedCallDataBase<CallDataGetHardwareLimits, ThisServiceType, DynExpProto::Common::VoidMessage, DynExpProto::NetworkAnalogIn::ValueLimitsMessage>
90  {
91  using Base = gRPCModule<gRPCServices...>::template TypedCallDataBase<CallDataGetHardwareLimits, ThisServiceType, DynExpProto::Common::VoidMessage, DynExpProto::NetworkAnalogIn::ValueLimitsMessage>;
92  using Base::ResponseMessage;
93 
94  public:
95  CallDataGetHardwareLimits(const gRPCModule<gRPCServices...>* const OwningModule) noexcept
96  : Base::TypedCallDataBase(OwningModule, &DynExpProto::NetworkAnalogIn::NetworkAnalogIn::AsyncService::RequestGetHardwareLimits) {}
97  virtual ~CallDataGetHardwareLimits() = default;
98 
99  private:
100  virtual void ProcessChildImpl(DynExp::ModuleInstance& Instance) override
101  {
102  auto ModuleData = DynExp::dynamic_ModuleData_cast<NetworkAnalogInT>(Instance.ModuleDataGetter());
103 
104  ResponseMessage.set_lowerlimit(ModuleData->GetAnalogIn()->GetHardwareMinValue());
105  ResponseMessage.set_upperlimit(ModuleData->GetAnalogIn()->GetHardwareMaxValue());
106  }
107  };
108 
110  : public gRPCModule<gRPCServices...>::template TypedCallDataBase<CallDataHardwareResolution, ThisServiceType, DynExpProto::Common::VoidMessage, DynExpProto::NetworkAnalogIn::ValueResolutionMessage>
111  {
112  using Base = gRPCModule<gRPCServices...>::template TypedCallDataBase<CallDataHardwareResolution, ThisServiceType, DynExpProto::Common::VoidMessage, DynExpProto::NetworkAnalogIn::ValueResolutionMessage>;
113  using Base::ResponseMessage;
114 
115  public:
116  CallDataHardwareResolution(const gRPCModule<gRPCServices...>* const OwningModule) noexcept
117  : Base::TypedCallDataBase(OwningModule, &DynExpProto::NetworkAnalogIn::NetworkAnalogIn::AsyncService::RequestGetHardwareResolution) {}
118  virtual ~CallDataHardwareResolution() = default;
119 
120  private:
121  virtual void ProcessChildImpl(DynExp::ModuleInstance& Instance) override
122  {
123  auto ModuleData = DynExp::dynamic_ModuleData_cast<NetworkAnalogInT>(Instance.ModuleDataGetter());
124 
125  ResponseMessage.set_resolution(ModuleData->GetAnalogIn()->GetHardwareResolution());
126  }
127  };
128 
130  : public gRPCModule<gRPCServices...>::template TypedCallDataBase<CallDataGetValueUnit, ThisServiceType, DynExpProto::Common::VoidMessage, DynExpProto::NetworkAnalogIn::ValueUnitMessage>
131  {
132  using Base = gRPCModule<gRPCServices...>::template TypedCallDataBase<CallDataGetValueUnit, ThisServiceType, DynExpProto::Common::VoidMessage, DynExpProto::NetworkAnalogIn::ValueUnitMessage>;
133  using Base::ResponseMessage;
134 
135  public:
136  CallDataGetValueUnit(const gRPCModule<gRPCServices...>* const OwningModule) noexcept
137  : Base::TypedCallDataBase(OwningModule, &DynExpProto::NetworkAnalogIn::NetworkAnalogIn::AsyncService::RequestGetValueUnit) {}
138  virtual ~CallDataGetValueUnit() = default;
139 
140  private:
141  virtual void ProcessChildImpl(DynExp::ModuleInstance& Instance) override
142  {
143  auto ModuleData = DynExp::dynamic_ModuleData_cast<NetworkAnalogInT>(Instance.ModuleDataGetter());
144 
145  ResponseMessage.set_unit(DynExpInstr::ToPrototUnitType(ModuleData->GetAnalogIn()->GetValueUnit()));
146  }
147  };
148 
150  : public gRPCModule<gRPCServices...>::template TypedCallDataBase<CallDataGetAsync, ThisServiceType, DynExpProto::Common::VoidMessage, DynExpProto::NetworkAnalogIn::SampleMessage>
151  {
152  using Base = gRPCModule<gRPCServices...>::template TypedCallDataBase<CallDataGetAsync, ThisServiceType, DynExpProto::Common::VoidMessage, DynExpProto::NetworkAnalogIn::SampleMessage>;
153  using Base::ResponseMessage;
154 
155  public:
156  CallDataGetAsync(const gRPCModule<gRPCServices...>* const OwningModule) noexcept
157  : Base::TypedCallDataBase(OwningModule, &DynExpProto::NetworkAnalogIn::NetworkAnalogIn::AsyncService::RequestGetAsync) {}
158  virtual ~CallDataGetAsync() = default;
159 
160  private:
161  virtual void ProcessChildImpl(DynExp::ModuleInstance& Instance) override
162  {
163  auto ModuleData = DynExp::dynamic_ModuleData_cast<NetworkAnalogInT>(Instance.ModuleDataGetter());
164 
165  ResponseMessage.set_value(ModuleData->GetAnalogIn()->Get());
166  }
167  };
168 
170  : public gRPCModule<gRPCServices...>::template TypedCallDataBase<CallDataGetSync, ThisServiceType, DynExpProto::Common::VoidMessage, DynExpProto::NetworkAnalogIn::SampleMessage>
171  {
172  using Base = gRPCModule<gRPCServices...>::template TypedCallDataBase<CallDataGetSync, ThisServiceType, DynExpProto::Common::VoidMessage, DynExpProto::NetworkAnalogIn::SampleMessage>;
173  using Base::ResponseMessage;
174 
175  public:
176  CallDataGetSync(const gRPCModule<gRPCServices...>* const OwningModule) noexcept
177  : Base::TypedCallDataBase(OwningModule, &DynExpProto::NetworkAnalogIn::NetworkAnalogIn::AsyncService::RequestGetSync) {}
178  virtual ~CallDataGetSync() = default;
179 
180  private:
181  virtual void ProcessChildImpl(DynExp::ModuleInstance& Instance) override
182  {
183  auto ModuleData = DynExp::dynamic_ModuleData_cast<NetworkAnalogInT>(Instance.ModuleDataGetter());
184 
185  ResponseMessage.set_value(ModuleData->GetAnalogIn()->GetSync());
186  }
187  };
188 
189  private:
191  {
193  }
194 
196 
198  {
199  CallDataGetHardwareLimits::MakeCall(this, Instance);
200  CallDataHardwareResolution::MakeCall(this, Instance);
201  CallDataGetValueUnit::MakeCall(this, Instance);
202  CallDataGetAsync::MakeCall(this, Instance);
203  CallDataGetSync::MakeCall(this, Instance);
204 
206  }
207 
209 
210  virtual void ValidateInstrType(const DynExpInstr::DataStreamInstrument* Instr) const override { DynExp::dynamic_Object_cast<typename ModuleDataType::InstrType>(Instr); }
211  };
212 
217 }
Implementation of a gRPC server module to provide remote access to a data stream instrument meta inst...
Meta instrument for a single analog input port based on the data stream and generic input port meta i...
Definition: AnalogIn.h:136
Implementation of the data stream meta instrument, which is a base class for all instruments reading/...
virtual DynExp::ParamsBasePtrType MakeParams(DynExp::ItemIDType ID, const DynExp::DynExpCore &Core) const override
Override to make derived classes call DynExp::MakeParams with the correct configurator type derived f...
void ResetImpl(DynExp::ModuleDataBase::dispatch_tag< NetworkDataStreamInstrumentData< gRPCServices... >>) override final
virtual void ResetImpl(DynExp::ModuleDataBase::dispatch_tag< NetworkAnalogInData >)
virtual ~NetworkAnalogInData()=default
virtual ~NetworkAnalogInParams()=default
void ConfigureParamsImpl(DynExp::ParamsBase::dispatch_tag< NetworkDataStreamInstrumentParams< gRPCServices... >>) override final
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...
virtual void ConfigureParamsImpl(DynExp::ParamsBase::dispatch_tag< NetworkAnalogInParams >)
DynExp::ParamsBase::DummyParam Dummy
NetworkAnalogInParams(DynExp::ItemIDType ID, const DynExp::DynExpCore &Core)
gRPCModule< gRPCServices... >::template TypedCallDataBase< CallDataGetAsync, ThisServiceType, DynExpProto::Common::VoidMessage, DynExpProto::NetworkAnalogIn::SampleMessage > Base
CallDataGetAsync(const gRPCModule< gRPCServices... > *const OwningModule) noexcept
virtual void ProcessChildImpl(DynExp::ModuleInstance &Instance) override
CallDataGetHardwareLimits(const gRPCModule< gRPCServices... > *const OwningModule) noexcept
gRPCModule< gRPCServices... >::template TypedCallDataBase< CallDataGetHardwareLimits, ThisServiceType, DynExpProto::Common::VoidMessage, DynExpProto::NetworkAnalogIn::ValueLimitsMessage > Base
virtual void ProcessChildImpl(DynExp::ModuleInstance &Instance) override
gRPCModule< gRPCServices... >::template TypedCallDataBase< CallDataGetSync, ThisServiceType, DynExpProto::Common::VoidMessage, DynExpProto::NetworkAnalogIn::SampleMessage > Base
virtual void ProcessChildImpl(DynExp::ModuleInstance &Instance) override
CallDataGetSync(const gRPCModule< gRPCServices... > *const OwningModule) noexcept
CallDataGetValueUnit(const gRPCModule< gRPCServices... > *const OwningModule) noexcept
gRPCModule< gRPCServices... >::template TypedCallDataBase< CallDataGetValueUnit, ThisServiceType, DynExpProto::Common::VoidMessage, DynExpProto::NetworkAnalogIn::ValueUnitMessage > Base
virtual void ProcessChildImpl(DynExp::ModuleInstance &Instance) override
gRPCModule< gRPCServices... >::template TypedCallDataBase< CallDataHardwareResolution, ThisServiceType, DynExpProto::Common::VoidMessage, DynExpProto::NetworkAnalogIn::ValueResolutionMessage > Base
CallDataHardwareResolution(const gRPCModule< gRPCServices... > *const OwningModule) noexcept
virtual void ProcessChildImpl(DynExp::ModuleInstance &Instance) override
void ResetImpl(DynExp::Object::dispatch_tag< NetworkDataStreamInstrumentT< gRPCServices... >>) override final
virtual ~NetworkAnalogInT()=default
virtual void CreateInitialCallDataObjectsImpl(DynExp::Object::dispatch_tag< NetworkAnalogInT >, DynExp::ModuleInstance &Instance) const
DynExpProto::NetworkAnalogIn::NetworkAnalogIn ThisServiceType
constexpr static auto Name() noexcept
virtual std::string GetName() const override
Returns the name of this Object type.
NetworkAnalogInT(const std::thread::id OwnerThreadID, DynExp::ParamsBasePtrType &&Params)
virtual void ValidateInstrType(const DynExpInstr::DataStreamInstrument *Instr) const override
void CreateInitialCallDataObjectsImpl(DynExp::Object::dispatch_tag< NetworkDataStreamInstrumentT< gRPCServices... >>, DynExp::ModuleInstance &Instance) const override final
virtual void ResetImpl(DynExp::Object::dispatch_tag< NetworkAnalogInT >)
Module template for building gRPC servers listening on TCP sockets for network instruments to connect...
Definition: gRPCModule.h:116
DynExp's core class acts as the interface between the user interface and DynExp's internal data like ...
Definition: DynExpCore.h:127
Base class for modules. Modules implement programs on their own (e.g. measurement protocols or server...
Definition: Module.h:392
const std::unique_ptr< ModuleDataType > ModuleData
Module data belonging to this ModuleBase instance.
Definition: Module.h:743
Configurator class for ModuleBase.
Definition: Module.h:374
Data structure to contain data which is synchronized in between different threads....
Definition: Module.h:171
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 ModuleBase::ModuleDataGetterType ModuleDataGetter
Getter for module's data. Refer to ModuleBase::ModuleDataGetterType.
Definition: Module.h:825
Parameter class for ModuleBase.
Definition: Module.h:337
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
Dummy parameter which is to be owned once by parameter classes that do not contain any other paramete...
Definition: Object.h:522
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
constexpr DynExpProto::Common::UnitType ToPrototUnitType(DataStreamInstrumentData::UnitType Unit)
DynExp's module namespace contains the implementation of DynExp modules which extend DynExp's core fu...
NetworkAnalogInT< typename NetworkDataStreamInstrument::ThisServiceType, DynExpProto::NetworkAnalogIn::NetworkAnalogIn > NetworkAnalogIn
Explicit instantiation of derivable class NetworkAnalogInT to create the network analog in module.
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.
Accumulates include statements to provide a precompiled header.