DynExp
Highly flexible laboratory automation for dynamically changing experiments.
DynExpInstr::LockinAmplifier Class Referenceabstract

Meta instrument for a lock-in amplifier based on the data stream meta instrument. More...

+ Inheritance diagram for DynExpInstr::LockinAmplifier:

Public Types

using ParamsType = LockinAmplifierParams
 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. More...
 
using ConfigType = LockinAmplifierConfigurator
 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. More...
 
using InstrumentDataType = LockinAmplifierData
 Type of the data class belonging to this InstrumentBase type. Declare this alias in every derived class with the respective data class accompanying the derived InstrumentBase. More...
 
gRPC aliases

Redefined to use this instrument with DynExpInstr::gRPCInstrument.

using InitTaskType = LockinAmplifierTasks::InitTask
 Defines a task for initializing an instrument within an instrument inheritance hierarchy. Each instrument (indirectly) derived from class InstrumentBase must be accompanied by an initialization task class derived from InitTaskBase. Even if the task does not do anything, at least it has to call InitTaskBase::InitFuncImpl() of the derived instrument's initialization task class. More...
 
using ExitTaskType = LockinAmplifierTasks::ExitTask
 Defines a task for deinitializing an instrument within an instrument inheritance hierarchy. Each instrument (indirectly) derived from class InstrumentBase must be accompanied by a deinitialization task class derived from ExitTaskBase. Even if the task does not do anything, at least it has to call ExitTaskBase::ExitFuncImpl() of the derived instrument's deinitialization task class. More...
 
using UpdateTaskType = LockinAmplifierTasks::UpdateTask
 Defines a task for updating an instrument within an instrument inheritance hierarchy. Each instrument (indirectly) derived from class InstrumentBase must be accompanied by an update task class derived from UpdateTaskBase. Even if the task does not do anything, at least it has to call UpdateTaskBase::UpdateFuncImpl() of the derived instrument's update task class. More...
 
- Public Types inherited from DynExpInstr::DataStreamInstrument
using ParamsType = DataStreamInstrumentParams
 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. More...
 
using ConfigType = DataStreamInstrumentConfigurator
 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. More...
 
using InstrumentDataType = DataStreamInstrumentData
 Type of the data class belonging to this InstrumentBase type. Declare this alias in every derived class with the respective data class accompanying the derived InstrumentBase. More...
 
using InitTaskType = DataStreamInstrumentTasks::InitTask
 Defines a task for initializing an instrument within an instrument inheritance hierarchy. Each instrument (indirectly) derived from class InstrumentBase must be accompanied by an initialization task class derived from InitTaskBase. Even if the task does not do anything, at least it has to call InitTaskBase::InitFuncImpl() of the derived instrument's initialization task class. More...
 
using ExitTaskType = DataStreamInstrumentTasks::ExitTask
 Defines a task for deinitializing an instrument within an instrument inheritance hierarchy. Each instrument (indirectly) derived from class InstrumentBase must be accompanied by a deinitialization task class derived from ExitTaskBase. Even if the task does not do anything, at least it has to call ExitTaskBase::ExitFuncImpl() of the derived instrument's deinitialization task class. More...
 
using UpdateTaskType = DataStreamInstrumentTasks::UpdateTask
 Defines a task for updating an instrument within an instrument inheritance hierarchy. Each instrument (indirectly) derived from class InstrumentBase must be accompanied by an update task class derived from UpdateTaskBase. Even if the task does not do anything, at least it has to call UpdateTaskBase::UpdateFuncImpl() of the derived instrument's update task class. More...
 
- Public Types inherited from DynExp::InstrumentBase
using ParamsType = InstrumentParamsBase
 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. More...
 
using ConfigType = InstrumentConfiguratorBase
 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. More...
 
using InstrumentDataType = InstrumentDataBase
 Type of the data class belonging to this InstrumentBase type. Declare this alias in every derived class with the respective data class accompanying the derived InstrumentBase. More...
 
using InstrumentDataTypeSyncPtrType = Util::SynchronizedPointer< InstrumentDataType >
 Alias for the return type of InstrumentBase::GetInstrumentData(). Data class instances wrapped into Util::SynchronizedPointer can be accessed in a thread-safe way. More...
 
using InstrumentDataTypeSyncPtrConstType = Util::SynchronizedPointer< const InstrumentDataType >
 Alias for the return type of InstrumentBase::GetInstrumentData() const. Data class instances wrapped into Util::SynchronizedPointer can be accessed in a thread-safe way. More...
 
using InitTaskType = InitTaskBase
 Defines a task for initializing an instrument within an instrument inheritance hierarchy. Each instrument (indirectly) derived from class InstrumentBase must be accompanied by an initialization task class derived from InitTaskBase. Even if the task does not do anything, at least it has to call InitTaskBase::InitFuncImpl() of the derived instrument's initialization task class. More...
 
using ExitTaskType = ExitTaskBase
 Defines a task for deinitializing an instrument within an instrument inheritance hierarchy. Each instrument (indirectly) derived from class InstrumentBase must be accompanied by a deinitialization task class derived from ExitTaskBase. Even if the task does not do anything, at least it has to call ExitTaskBase::ExitFuncImpl() of the derived instrument's deinitialization task class. More...
 
using UpdateTaskType = UpdateTaskBase
 Defines a task for updating an instrument within an instrument inheritance hierarchy. Each instrument (indirectly) derived from class InstrumentBase must be accompanied by an update task class derived from UpdateTaskBase. Even if the task does not do anything, at least it has to call UpdateTaskBase::UpdateFuncImpl() of the derived instrument's update task class. More...
 
using InstrumentDataGetterType = Util::CallableMemberWrapper< InstrumentBase, InstrumentDataTypeSyncPtrType(InstrumentBase::*)(const std::chrono::milliseconds)>
 Invoking an instance of this alias is supposed to call InstrumentBase::GetInstrumentData() of the instance the Util::CallableMemberWrapper has been constructed with. More...
 
- 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. More...
 
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. More...
 
- 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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 

Public Member Functions

 LockinAmplifier (const std::thread::id OwnerThreadID, DynExp::ParamsBasePtrType &&Params)
 Constructs an instrument instance. More...
 
virtual ~LockinAmplifier ()=0
 
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...
 
virtual std::chrono::milliseconds GetTaskQueueDelay () const override
 Specifies in which time intervals the instrument's task queue runs to handle pending tasks. More...
 
void PersistDataToParams () const
 Retrieves the current lock-in amplifier settings and stores them in the instrument parameters to save them to the project file. The function updates the parameters belonging to LockinAmplifierParams. Then, it calls PersistDataToParamsImpl() making use of the tag dispatch mechanism (refer to DynExp::ParamsBase::dispatch_tag) to let derived classes store additional settings they are responsible for in the instrument parameters. More...
 
void ApplyFromParams () const
 Applies the lock-in amplifier settings stored in the instrument parameters to the physical device. The function only calls ApplyFromParamsImpl() making use of the tag dispatch mechanism (refer to DynExp::ParamsBase::dispatch_tag) to let derived classes apply the settings they are responsible for (by knowing how to apply them). More...
 
Override (instrument information)

Override by derived classes to provide information about the instrument.

virtual const char * GetSensitivityUnitString () const noexcept=0
 Determines the unit of the lock-in amplifier's sensitivity/amplification setting and returns a human-readable string to represent that unit. More...
 
Override (instrument tasks)

Override by derived classes to insert tasks into the instrument's task queue. Logical const-ness: const member functions to allow modules inserting tasks into the instrument's task queue.

virtual void SetSensitivity (double Sensitivity, DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const =0
 Sets the lock-in amplifier's sensitivity/amplification. More...
 
virtual void AutoAdjustSensitivity (DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const
 Makes the lock-in amplifier automatically set its sensitivity/amplification. More...
 
virtual void SetPhase (double Phase, DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const =0
 Sets the phase of the lock-in amplifier's demodulator. More...
 
virtual void AutoAdjustPhase (DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const
 Makes the lock-in amplifier automatically set its demodulator's phase. More...
 
virtual void SetTimeConstant (double TimeConstant, DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const =0
 Sets the time constant of the lock-in amplifier's low-poss filter. More...
 
virtual void SetFilterOrder (uint8_t FilterOrder, DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const
 Sets the filter order/quality of the lock-in amplifier's low-poss filter. More...
 
virtual void SetTriggerMode (LockinAmplifierDefs::TriggerModeType TriggerMode, DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const
 Sets the lock-in amplifier's trigger mode. More...
 
virtual void SetTriggerEdge (LockinAmplifierDefs::TriggerEdgeType TriggerEdge, DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const
 Sets the lock-in amplifier's trigger edge. More...
 
virtual void SetSignalType (LockinAmplifierDefs::SignalType SignalType, DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const =0
 Sets the lock-in amplifier's signal coordinate type to read out. More...
 
virtual void SetSamplingRate (double SamplingRate, DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const
 Sets the lock-in amplifier's sampling rate. More...
 
virtual void SetEnable (bool Enable, DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const
 Enables or disables the lock-in amplifier's demodulator. More...
 
virtual void ForceTrigger (DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const
 Forces (starts) the data acquisition ignoring the trigger. More...
 
- Public Member Functions inherited from DynExpInstr::DataStreamInstrument
 DataStreamInstrument (const std::thread::id OwnerThreadID, DynExp::ParamsBasePtrType &&Params)
 Constructs an instrument instance. More...
 
virtual ~DataStreamInstrument ()=0
 
const char * GetValueUnitStr () const noexcept
 Builds and returns a descriptive string of the unit corresponding to the values managed by this DataStreamInstrument instance. More...
 
bool CanRead (const std::chrono::milliseconds Timeout=GetInstrumentDataTimeoutDefault) const
 Calls ReadData(), locks the instrument data, and determines whether at least one sample can be read from the instrument's data stream. More...
 
void Clear (const std::chrono::milliseconds Timeout=GetInstrumentDataTimeoutDefault) const
 Immediately clears the instrument's data stream and then issues a ClearData task by locking the instrument data first, calling DataStreamBase::Clear(), and finally calling ClearData(). More...
 
virtual DataStreamInstrumentData::UnitType GetValueUnit () const =0
 Determines which unit corresponds to the values managed by this DataStreamInstrument instance. Do not enforce noexcept to allow overriding functions which throw exceptions. More...
 
virtual void ReadData (DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const
 Enqueues a task to read data from the hardware to the data stream. The default implementation does nothing. More...
 
virtual void WriteData (DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const
 Enqueues a task to write data from the data stream to the hardware. More...
 
virtual void ClearData (DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const
 Enqueues a task to clear the underlying hardware adapter's buffer. More...
 
virtual void Start (DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const
 Enqueues a task to make the underlying hardware adapter start data acquisition or writing data. More...
 
virtual void Stop (DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const
 Enqueues a task to make the underlying hardware adapter stop data acquisition or writing data. More...
 
virtual void Restart (DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const
 Enqueues a task to make the underlying hardware adapter restart data acquisition or writing data. The default implementation calls Stop() and then Start(). More...
 
virtual void SetStreamSize (size_t BufferSizeInSamples, DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const
 Enqueues a task to set the size of the instrument's sample stream. The default implementation just calls DataStreamBase::SetStreamSize() via a DataStreamInstrumentTasks::SetStreamSizeTask task. More...
 
virtual void ResetStreamSize (DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const
 Enqueues a task to reset the size of the instrument's sample stream to its default value. More...
 
virtual Util::OptionalBool HasFinished () const
 Determines whether the underlying hardware adapter finished data acquisition or writing data. More...
 
virtual Util::OptionalBool IsRunning () const
 Determines whether the underlying hardware adapter is running a data acquisition or writing data. More...
 
- Public Member Functions inherited from DynExp::InstrumentBase
 InstrumentBase (const std::thread::id OwnerThreadID, ParamsBasePtrType &&Params)
 Constructs an instrument instance. More...
 
virtual ~InstrumentBase ()=0
 
template<typename DerivedInstrT , typename... TaskFuncArgTs, typename... ArgTs>
ExceptionContainer AsSyncTask (void(DerivedInstrT::*TaskFunc)(TaskFuncArgTs...) const, ArgTs &&...Args) const
 Calls a (derived) instrument's function which inserts a task into the instrument's task queue synchronously. This means that AsSyncTask() blocks until the task has been executed or aborted. This is achieved by passing a callback function to the task which in turn sets a flag after the task execution. The thread calling AsSyncTask() blocks (via std::this_thread::yield()) until this flag is set. More...
 
InstrumentDataTypeSyncPtrType GetInstrumentData (const std::chrono::milliseconds Timeout=GetInstrumentDataTimeoutDefault)
 Locks the mutex of the instrument data class instance InstrumentData assigned to this InstrumentBase instance and returns a pointer to the locked InstrumentData. Instrument data should not be locked by having called this function while subsequently calling a derived instrument's method which also makes use of the instrument's data by locking it. If this happens (e.g. in a module thread), the instrument 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...
 
InstrumentDataTypeSyncPtrConstType GetInstrumentData (const std::chrono::milliseconds Timeout=GetInstrumentDataTimeoutDefault) const
 Locks the mutex of the instrument data class instance InstrumentData assigned to this InstrumentBase instance and returns a pointer to the locked InstrumentData. Instrument data should not be locked by having called this function while subsequently calling a derived instrument's method which also makes use of the instrument's data by locking it. If this happens (e.g. in a module thread), the instrument 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 UpdateData () const
 Enqueues an update task (instance of class UpdateTaskBase). More...
 
void EnqueueArriveAtLatchTask (std::latch &Latch) const
 Enqueues a task which arrives at a latch when executed (instance of class ArriveAtLatchTask). More...
 
bool IsInitialized () const
 Getter for Initialized. More...
 
- Public Member Functions inherited from DynExp::RunnableObject
 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...
 
- Public Member Functions inherited from Util::INonCopyable
 INonCopyable (const INonCopyable &)=delete
 
INonCopyableoperator= (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. 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...
 

Static Public Member Functions

constexpr static auto Name () noexcept
 Every derived class has to redefine this function. More...
 
constexpr static auto Category () noexcept
 Every derived class has to redefine this function. More...
 
- Static Public Member Functions inherited from DynExpInstr::DataStreamInstrument
constexpr static auto Name () noexcept
 Every derived class has to redefine this function. More...
 
constexpr static auto Category () noexcept
 Every derived class has to redefine this function. More...
 
- Static Public Member Functions inherited from DynExp::InstrumentBase
constexpr static auto Category () noexcept
 Every derived class has to redefine this function. More...
 
- 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. More...
 

Private Member Functions

void ResetImpl (dispatch_tag< DataStreamInstrument >) override final
 Refer to DynExp::Object::Reset(). Using tag dispatch mechanism to ensure that ResetImpl() of every derived class gets called - starting from DynExp::Object, descending the inheritance hierarchy. More...
 
virtual void ResetImpl (dispatch_tag< LockinAmplifier >)=0
 Refer to DynExp::Object::Reset(). Using tag dispatch mechanism to ensure that ResetImpl() of every derived class gets called - starting from DynExp::Object, descending the inheritance hierarchy. More...
 
virtual std::unique_ptr< DynExp::InitTaskBaseMakeInitTask () const override
 Factory function for an init task (InitTaskBase). Override to define the desired initialization task in derived classes only if the respective task really does something and if it has no pure virtual function. More...
 
virtual std::unique_ptr< DynExp::ExitTaskBaseMakeExitTask () const override
 Factory function for an exit task (ExitTaskBase). Override to define the desired deinitialization task in derived classes only if the respective task really does something and if it has no pure virtual function. More...
 
virtual std::unique_ptr< DynExp::UpdateTaskBaseMakeUpdateTask () const override
 Factory function for an update task (UpdateTaskBase). Override to define the desired update task in derived classes only if the respective task really does something and if it has no pure virtual function. More...
 
Override

Override by derived classes.

virtual void PersistDataToParamsImpl (dispatch_tag< LockinAmplifier >) const
 Refer to PersistDataToParams(). Using tag dispatch mechanism to ensure that PersistDataToParamsImpl() of every derived class gets called - starting from LockinAmplifier, descending the inheritance hierarchy. More...
 
virtual void ApplyFromParamsImpl (dispatch_tag< LockinAmplifier >) const =0
 Refer to ApplyFromParams(). Using tag dispatch mechanism to ensure that ApplyFromParamsImpl() of every derived class gets called - starting from LockinAmplifier, descending the inheritance hierarchy. More...
 

Additional Inherited Members

- Public Attributes inherited from DynExp::InstrumentBase
InstrumenThreadOnlyType InstrumentThreadOnly
 Allow exclusive access to some of InstrumentBase's private methods to the instrument thread InstrumentThreadMain(). More...
 
- Public Attributes inherited from DynExp::RunnableObject
RunnableInstanceOnlyType RunnableInstanceOnly
 Allow exclusive access to some of RunnableObject's private methods to class RunnableInstance. More...
 
- Public Attributes inherited from DynExp::Object
LinkedObjectWrapperOnlyType LinkedObjectWrapperOnly
 Allow exclusive access to some of Object's private methods to any LinkedObjectWrapper<T>. More...
 
- Static Public Attributes inherited from DynExp::InstrumentBase
static constexpr auto GetInstrumentDataTimeoutDefault = std::chrono::milliseconds(1000)
 Determines the default timeout for GetInstrumentData() to lock the mutex synchronizing the instrument's data InstrumentData. More...
 
- 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. More...
 
static constexpr auto TerminateTimeoutDefault = std::chrono::milliseconds(3000)
 Default timeout used as a default for calls to RunnableObject::Terminate. More...
 
- 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. More...
 
- Protected Member Functions inherited from DynExp::InstrumentBase
template<typename TaskT , typename... ArgTs>
void MakeAndEnqueueTask (ArgTs &&...Args) const
 Calls MakeTask() to construct a new task and subsequently enqueues the task into the instrument's task queue. Logical const-ness: this is a const member function to allow pointers to const InstrumentBase inserting tasks into the instrument's task queue. These kind of pointers are e.g. returned by RunnableInstance::GetOwner() which can be called by tasks' TaskBase::RunChild() functions. For const InstrumentBase*, it is possible to insert tasks into the task queue, but not to change the InstrumentBase object itself (e.g. calling Object::Reset()). More...
 
- Protected Member Functions inherited from DynExp::RunnableObject
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...
 
- 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. 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 Protected Member Functions inherited from DynExp::InstrumentBase
static auto GetExceptionUnsafe (const InstrumentDataTypeSyncPtrConstType &InstrumentDataPtr)
 Getter for InstrumentDataBase::InstrumentException. More...
 

Detailed Description

Meta instrument for a lock-in amplifier based on the data stream meta instrument.

Definition at line 438 of file LockinAmplifier.h.

Member Typedef Documentation

◆ ConfigType

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.

Definition at line 442 of file LockinAmplifier.h.

◆ ExitTaskType

Defines a task for deinitializing an instrument within an instrument inheritance hierarchy. Each instrument (indirectly) derived from class InstrumentBase must be accompanied by a deinitialization task class derived from ExitTaskBase. Even if the task does not do anything, at least it has to call ExitTaskBase::ExitFuncImpl() of the derived instrument's deinitialization task class.

Definition at line 450 of file LockinAmplifier.h.

◆ InitTaskType

Defines a task for initializing an instrument within an instrument inheritance hierarchy. Each instrument (indirectly) derived from class InstrumentBase must be accompanied by an initialization task class derived from InitTaskBase. Even if the task does not do anything, at least it has to call InitTaskBase::InitFuncImpl() of the derived instrument's initialization task class.

Definition at line 449 of file LockinAmplifier.h.

◆ InstrumentDataType

Type of the data class belonging to this InstrumentBase type. Declare this alias in every derived class with the respective data class accompanying the derived InstrumentBase.

Definition at line 443 of file LockinAmplifier.h.

◆ ParamsType

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.

Definition at line 441 of file LockinAmplifier.h.

◆ UpdateTaskType

Defines a task for updating an instrument within an instrument inheritance hierarchy. Each instrument (indirectly) derived from class InstrumentBase must be accompanied by an update task class derived from UpdateTaskBase. Even if the task does not do anything, at least it has to call UpdateTaskBase::UpdateFuncImpl() of the derived instrument's update task class.

Definition at line 451 of file LockinAmplifier.h.

Constructor & Destructor Documentation

◆ LockinAmplifier()

DynExpInstr::LockinAmplifier::LockinAmplifier ( const std::thread::id  OwnerThreadID,
DynExp::ParamsBasePtrType &&  Params 
)
inline

Constructs an instrument instance.

Parameters
OwnerThreadIDThread id of the thread owning the Object instance to be constructed.
ParamsParameter class instance to be assigned to the Object instance to be constructed.
Exceptions
Util::InvalidArgExceptionis thrown if OwnerThreadID is an invalid thread id or if Params is nullptr.
Util::InvalidArgExceptionis thrown if InstrumentParamsBase::InstrumentData of Params is nullptr.

Definition at line 460 of file LockinAmplifier.h.

◆ ~LockinAmplifier()

DynExpInstr::LockinAmplifier::~LockinAmplifier ( )
pure virtual

Definition at line 92 of file LockinAmplifier.cpp.

Member Function Documentation

◆ ApplyFromParams()

void DynExpInstr::LockinAmplifier::ApplyFromParams ( ) const

Applies the lock-in amplifier settings stored in the instrument parameters to the physical device. The function only calls ApplyFromParamsImpl() making use of the tag dispatch mechanism (refer to DynExp::ParamsBase::dispatch_tag) to let derived classes apply the settings they are responsible for (by knowing how to apply them).

Definition at line 114 of file LockinAmplifier.cpp.

◆ ApplyFromParamsImpl()

virtual void DynExpInstr::LockinAmplifier::ApplyFromParamsImpl ( dispatch_tag< LockinAmplifier ) const
privatepure virtual

Refer to ApplyFromParams(). Using tag dispatch mechanism to ensure that ApplyFromParamsImpl() of every derived class gets called - starting from LockinAmplifier, descending the inheritance hierarchy.

Implemented in DynExpInstr::ZI_MFLI.

◆ AutoAdjustPhase()

void DynExpInstr::LockinAmplifier::AutoAdjustPhase ( DynExp::TaskBase::CallbackType  CallbackFunc = nullptr) const
virtual

Makes the lock-in amplifier automatically set its demodulator's phase.

Parameters
CallbackFuncThis callback function is called after the task has finished (either successfully or not) with a reference to the current task and with a reference to the exception which occurred during the task execution (if an exception has occurred).
Exceptions
Util::NotImplementedExceptionis thrown by the default implementation, which does not do anything more.

Reimplemented in DynExpInstr::ZI_MFLI.

Definition at line 124 of file LockinAmplifier.cpp.

◆ AutoAdjustSensitivity()

void DynExpInstr::LockinAmplifier::AutoAdjustSensitivity ( DynExp::TaskBase::CallbackType  CallbackFunc = nullptr) const
virtual

Makes the lock-in amplifier automatically set its sensitivity/amplification.

Parameters
CallbackFuncThis callback function is called after the task has finished (either successfully or not) with a reference to the current task and with a reference to the exception which occurred during the task execution (if an exception has occurred).
Exceptions
Util::NotImplementedExceptionis thrown by the default implementation, which does not do anything more.

Reimplemented in DynExpInstr::ZI_MFLI.

Definition at line 119 of file LockinAmplifier.cpp.

◆ Category()

constexpr static auto DynExpInstr::LockinAmplifier::Category ( )
inlinestaticconstexprnoexcept

Every derived class has to redefine this function.

Returns
Returns the category of this instrument type.

Definition at line 455 of file LockinAmplifier.h.

◆ ForceTrigger()

void DynExpInstr::LockinAmplifier::ForceTrigger ( DynExp::TaskBase::CallbackType  CallbackFunc = nullptr) const
virtual

Forces (starts) the data acquisition ignoring the trigger.

Parameters
CallbackFuncThis callback function is called after the task has finished (either successfully or not) with a reference to the current task and with a reference to the exception which occurred during the task execution (if an exception has occurred).
Exceptions
Util::NotImplementedExceptionis thrown by the default implementation, which does not do anything more.

Reimplemented in DynExpInstr::ZI_MFLI.

Definition at line 154 of file LockinAmplifier.cpp.

◆ GetCategory()

virtual std::string DynExpInstr::LockinAmplifier::GetCategory ( ) const
inlineoverridevirtual

Returns the category of this Object type.

Reimplemented from DynExpInstr::DataStreamInstrument.

Definition at line 466 of file LockinAmplifier.h.

◆ GetName()

virtual std::string DynExpInstr::LockinAmplifier::GetName ( ) const
inlineoverridevirtual

Returns the name of this Object type.

Reimplemented from DynExpInstr::DataStreamInstrument.

Reimplemented in DynExpInstr::ZI_MFLI.

Definition at line 465 of file LockinAmplifier.h.

◆ GetSensitivityUnitString()

virtual const char* DynExpInstr::LockinAmplifier::GetSensitivityUnitString ( ) const
pure virtualnoexcept

Determines the unit of the lock-in amplifier's sensitivity/amplification setting and returns a human-readable string to represent that unit.

Returns
Unit string corresponding to the lock-in amplifier's sensitivity/amplification setting

Implemented in DynExpInstr::ZI_MFLI.

◆ GetTaskQueueDelay()

virtual std::chrono::milliseconds DynExpInstr::LockinAmplifier::GetTaskQueueDelay ( ) const
inlineoverridevirtual

Specifies in which time intervals the instrument's task queue runs to handle pending tasks.

Returns
Delay time in between task queue executions. Return std::chrono::milliseconds::max() to make the instrument thread only wake up (to handle tasks and to update data) when a task is enqueued. Return 0 to make the task queue delay as small as as possible.

Reimplemented from DynExp::InstrumentBase.

Reimplemented in DynExpInstr::ZI_MFLI.

Definition at line 468 of file LockinAmplifier.h.

◆ MakeExitTask()

virtual std::unique_ptr<DynExp::ExitTaskBase> DynExpInstr::LockinAmplifier::MakeExitTask ( ) const
inlineoverrideprivatevirtual

Factory function for an exit task (ExitTaskBase). Override to define the desired deinitialization task in derived classes only if the respective task really does something and if it has no pure virtual function.

Returns
Pointer to the task (transferring ownership) or nullptr if no exit task is required. A task can be created with MakeTask().

Reimplemented from DynExpInstr::DataStreamInstrument.

Reimplemented in DynExpInstr::ZI_MFLI.

Definition at line 631 of file LockinAmplifier.h.

◆ MakeInitTask()

virtual std::unique_ptr<DynExp::InitTaskBase> DynExpInstr::LockinAmplifier::MakeInitTask ( ) const
inlineoverrideprivatevirtual

Factory function for an init task (InitTaskBase). Override to define the desired initialization task in derived classes only if the respective task really does something and if it has no pure virtual function.

Returns
Pointer to the task (transferring ownership) or nullptr if no init task is required. A task can be created with MakeTask().

Reimplemented from DynExpInstr::DataStreamInstrument.

Reimplemented in DynExpInstr::ZI_MFLI.

Definition at line 630 of file LockinAmplifier.h.

◆ MakeUpdateTask()

virtual std::unique_ptr<DynExp::UpdateTaskBase> DynExpInstr::LockinAmplifier::MakeUpdateTask ( ) const
inlineoverrideprivatevirtual

Factory function for an update task (UpdateTaskBase). Override to define the desired update task in derived classes only if the respective task really does something and if it has no pure virtual function.

Returns
Pointer to the task (transferring ownership) or nullptr if no update task is required. A task can be created with MakeTask().

Reimplemented from DynExpInstr::DataStreamInstrument.

Reimplemented in DynExpInstr::ZI_MFLI.

Definition at line 632 of file LockinAmplifier.h.

◆ Name()

constexpr static auto DynExpInstr::LockinAmplifier::Name ( )
inlinestaticconstexprnoexcept

Every derived class has to redefine this function.

Returns
Returns the name of this DynExp object type.

Definition at line 454 of file LockinAmplifier.h.

◆ PersistDataToParams()

void DynExpInstr::LockinAmplifier::PersistDataToParams ( ) const

Retrieves the current lock-in amplifier settings and stores them in the instrument parameters to save them to the project file. The function updates the parameters belonging to LockinAmplifierParams. Then, it calls PersistDataToParamsImpl() making use of the tag dispatch mechanism (refer to DynExp::ParamsBase::dispatch_tag) to let derived classes store additional settings they are responsible for in the instrument parameters.

Definition at line 96 of file LockinAmplifier.cpp.

◆ PersistDataToParamsImpl()

virtual void DynExpInstr::LockinAmplifier::PersistDataToParamsImpl ( dispatch_tag< LockinAmplifier ) const
inlineprivatevirtual

Refer to PersistDataToParams(). Using tag dispatch mechanism to ensure that PersistDataToParamsImpl() of every derived class gets called - starting from LockinAmplifier, descending the inheritance hierarchy.

Definition at line 620 of file LockinAmplifier.h.

◆ ResetImpl() [1/2]

void DynExpInstr::LockinAmplifier::ResetImpl ( dispatch_tag< DataStreamInstrument )
finaloverrideprivatevirtual

Refer to DynExp::Object::Reset(). Using tag dispatch mechanism to ensure that ResetImpl() of every derived class gets called - starting from DynExp::Object, descending the inheritance hierarchy.

Implements DynExpInstr::DataStreamInstrument.

Definition at line 159 of file LockinAmplifier.cpp.

◆ ResetImpl() [2/2]

virtual void DynExpInstr::LockinAmplifier::ResetImpl ( dispatch_tag< LockinAmplifier )
privatepure virtual

Refer to DynExp::Object::Reset(). Using tag dispatch mechanism to ensure that ResetImpl() of every derived class gets called - starting from DynExp::Object, descending the inheritance hierarchy.

Implemented in DynExpInstr::ZI_MFLI.

◆ SetEnable()

void DynExpInstr::LockinAmplifier::SetEnable ( bool  Enable,
DynExp::TaskBase::CallbackType  CallbackFunc = nullptr 
) const
virtual

Enables or disables the lock-in amplifier's demodulator.

Parameters
EnablePass true to enable or false to disable the demodulator.
CallbackFuncThis callback function is called after the task has finished (either successfully or not) with a reference to the current task and with a reference to the exception which occurred during the task execution (if an exception has occurred).
Exceptions
Util::NotImplementedExceptionis thrown by the default implementation, which does not do anything more.

Reimplemented in DynExpInstr::ZI_MFLI.

Definition at line 149 of file LockinAmplifier.cpp.

◆ SetFilterOrder()

void DynExpInstr::LockinAmplifier::SetFilterOrder ( uint8_t  FilterOrder,
DynExp::TaskBase::CallbackType  CallbackFunc = nullptr 
) const
virtual

Sets the filter order/quality of the lock-in amplifier's low-poss filter.

Parameters
FilterOrderFilter order/quality
CallbackFuncThis callback function is called after the task has finished (either successfully or not) with a reference to the current task and with a reference to the exception which occurred during the task execution (if an exception has occurred).
Exceptions
Util::NotImplementedExceptionis thrown by the default implementation, which does not do anything more.

Reimplemented in DynExpInstr::ZI_MFLI.

Definition at line 129 of file LockinAmplifier.cpp.

◆ SetPhase()

virtual void DynExpInstr::LockinAmplifier::SetPhase ( double  Phase,
DynExp::TaskBase::CallbackType  CallbackFunc = nullptr 
) const
pure virtual

Sets the phase of the lock-in amplifier's demodulator.

Parameters
PhasePhase in rad
CallbackFuncThis callback function is called after the task has finished (either successfully or not) with a reference to the current task and with a reference to the exception which occurred during the task execution (if an exception has occurred).

Implemented in DynExpInstr::ZI_MFLI.

◆ SetSamplingRate()

void DynExpInstr::LockinAmplifier::SetSamplingRate ( double  SamplingRate,
DynExp::TaskBase::CallbackType  CallbackFunc = nullptr 
) const
virtual

Sets the lock-in amplifier's sampling rate.

Parameters
SamplingRateSampling rate in samples/s
CallbackFuncThis callback function is called after the task has finished (either successfully or not) with a reference to the current task and with a reference to the exception which occurred during the task execution (if an exception has occurred).
Exceptions
Util::NotImplementedExceptionis thrown by the default implementation, which does not do anything more.

Reimplemented in DynExpInstr::ZI_MFLI.

Definition at line 144 of file LockinAmplifier.cpp.

◆ SetSensitivity()

virtual void DynExpInstr::LockinAmplifier::SetSensitivity ( double  Sensitivity,
DynExp::TaskBase::CallbackType  CallbackFunc = nullptr 
) const
pure virtual

Sets the lock-in amplifier's sensitivity/amplification.

Parameters
SensitivitySensitivity/amplification in units as determined by GetSensitivityUnitString().
CallbackFuncThis callback function is called after the task has finished (either successfully or not) with a reference to the current task and with a reference to the exception which occurred during the task execution (if an exception has occurred).

Implemented in DynExpInstr::ZI_MFLI.

◆ SetSignalType()

virtual void DynExpInstr::LockinAmplifier::SetSignalType ( LockinAmplifierDefs::SignalType  SignalType,
DynExp::TaskBase::CallbackType  CallbackFunc = nullptr 
) const
pure virtual

Sets the lock-in amplifier's signal coordinate type to read out.

Parameters
SignalTypeSignal coordinate to read out and to write to the instrument's data stream
CallbackFuncThis callback function is called after the task has finished (either successfully or not) with a reference to the current task and with a reference to the exception which occurred during the task execution (if an exception has occurred).

Implemented in DynExpInstr::ZI_MFLI.

◆ SetTimeConstant()

virtual void DynExpInstr::LockinAmplifier::SetTimeConstant ( double  TimeConstant,
DynExp::TaskBase::CallbackType  CallbackFunc = nullptr 
) const
pure virtual

Sets the time constant of the lock-in amplifier's low-poss filter.

Parameters
TimeConstantTime constant in seconds
CallbackFuncThis callback function is called after the task has finished (either successfully or not) with a reference to the current task and with a reference to the exception which occurred during the task execution (if an exception has occurred).

Implemented in DynExpInstr::ZI_MFLI.

◆ SetTriggerEdge()

void DynExpInstr::LockinAmplifier::SetTriggerEdge ( LockinAmplifierDefs::TriggerEdgeType  TriggerEdge,
DynExp::TaskBase::CallbackType  CallbackFunc = nullptr 
) const
virtual

Sets the lock-in amplifier's trigger edge.

Parameters
TriggerEdgeEdge to trigger on
CallbackFuncThis callback function is called after the task has finished (either successfully or not) with a reference to the current task and with a reference to the exception which occurred during the task execution (if an exception has occurred).
Exceptions
Util::NotImplementedExceptionis thrown by the default implementation, which does not do anything more.

Reimplemented in DynExpInstr::ZI_MFLI.

Definition at line 139 of file LockinAmplifier.cpp.

◆ SetTriggerMode()

void DynExpInstr::LockinAmplifier::SetTriggerMode ( LockinAmplifierDefs::TriggerModeType  TriggerMode,
DynExp::TaskBase::CallbackType  CallbackFunc = nullptr 
) const
virtual

Sets the lock-in amplifier's trigger mode.

Parameters
TriggerModeTrigger mode
CallbackFuncThis callback function is called after the task has finished (either successfully or not) with a reference to the current task and with a reference to the exception which occurred during the task execution (if an exception has occurred).
Exceptions
Util::NotImplementedExceptionis thrown by the default implementation, which does not do anything more.

Reimplemented in DynExpInstr::ZI_MFLI.

Definition at line 134 of file LockinAmplifier.cpp.


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