DynExp
Highly flexible laboratory automation for dynamically changing experiments.
|
Implementation of a meta instrument to control single-axis positioner stages. More...
Public Types | |
enum class | DirectionType { Forward , Backward } |
Type to determine the direction of the positioner stage's movements. More... | |
using | ParamsType = PositionerStageParams |
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 = PositionerStageConfigurator |
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 = PositionerStageData |
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 = PositionerStageTasks::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 = PositionerStageTasks::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 = PositionerStageTasks::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 | |
PositionerStage (const std::thread::id OwnerThreadID, DynExp::ParamsBasePtrType &&Params) | |
Constructs an instrument instance. More... | |
virtual | ~PositionerStage ()=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... | |
Override (instrument information) | |
Override by derived classes to provide information about the instrument. | |
virtual PositionerStageData::PositionType | GetMinPosition () const noexcept=0 |
Returns the minimal position the stage can move to in nm if the stage supports SI units, in step units otherwise. More... | |
virtual PositionerStageData::PositionType | GetMaxPosition () const noexcept=0 |
Returns the maximal position the stage can move to in nm if the stage supports SI units, in step units otherwise. More... | |
virtual PositionerStageData::PositionType | GetResolution () const noexcept=0 |
Returns the stage's position resolution (precision) in nm if the stage supports SI units, in step units otherwise. More... | |
virtual PositionerStageData::PositionType | GetMinVelocity () const noexcept=0 |
Returns the minimal velocity the stage can move with in nm/s if the stage supports SI units, in steps/s otherwise. More... | |
virtual PositionerStageData::PositionType | GetMaxVelocity () const noexcept=0 |
Returns the maximal velocity the stage can move with in nm/s if the stage supports SI units, in steps/s otherwise. More... | |
virtual PositionerStageData::PositionType | GetDefaultVelocity () const noexcept=0 |
Returns the stage's default velocity in nm/s if the stage supports SI units, in steps/s otherwise. More... | |
virtual double | GetStepNanoMeterRatio () const noexcept |
Determines the conversion factor in between internal PositionerStageData::PositionType positiond and velocities and the units the underlying hardware expects. More... | |
virtual bool | IsUsingSIUnits () const noexcept |
Determines whether the underlying hardware expects SI units for positions and velocities or arbitrary units. 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 | SetHome () const |
Stores the positioner's home position. Also refer to MoveToHome() . More... | |
virtual void | Reference (DirectionType Direction=DirectionType::Forward, DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const |
References the positioner such that it finds its zero position or end stop. More... | |
virtual void | Calibrate (DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const |
Calibrates the positioner. The meaning of such a calibration is solely specified by the hardware manufacturer of the respective positioner type. More... | |
virtual void | SetVelocity (const PositionerStageData::PositionType Velocity) const =0 |
Sets the positioner's velocity in its native units. Do divide units of PositionerStageData::Velocity by GetStepNanoMeterRatio() to obtain native units. Also refer to IsUsingSIUnits() . More... | |
virtual void | MoveToHome (DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const |
Moves the positioner to its stored home position. Also refer to SetHome() . More... | |
virtual void | MoveAbsolute (const PositionerStageData::PositionType Steps, DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const =0 |
Moves the positioner to an absolute position in its native units. Do divide units of PositionerStageData::Position by GetStepNanoMeterRatio() to obtain native units. Also refer to IsUsingSIUnits() . More... | |
virtual void | MoveRelative (const PositionerStageData::PositionType Steps, DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const =0 |
Moves the positioner to a position relative to its current position. The position offset Steps has to be specified in native units. Do divide units of PositionerStageData::Position by GetStepNanoMeterRatio() to obtain native units. Also refer to IsUsingSIUnits() . More... | |
virtual void | StopMotion () const =0 |
Stops any motion or position stabilization of the positioner immediately. 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 | |
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. 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 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< InstrumentBase >) override final |
virtual void | ResetImpl (dispatch_tag< PositionerStage >)=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... | |
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... | |
Implementation of a meta instrument to control single-axis positioner stages.
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.
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.
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.
|
strong |
|
inline |
Constructs an instrument instance.
OwnerThreadID | Thread id of the thread owning the Object instance to be constructed. |
Params | Parameter class instance to be assigned to the Object instance to be constructed. |
Util::InvalidArgException | is thrown if OwnerThreadID is an invalid thread id or if Params is nullptr. |
Util::InvalidArgException | is thrown if InstrumentParamsBase::InstrumentData of Params is nullptr. |
|
pure virtual |
|
virtual |
Calibrates the positioner. The meaning of such a calibration is solely specified by the hardware manufacturer of the respective positioner type.
CallbackFunc | This 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). |
Util::NotImplementedException | is thrown by the default implementation, which does not do anything more. |
Reimplemented in DynExpInstr::SmarAct.
|
inlinestaticconstexprnoexcept |
|
inlineoverridevirtual |
Returns the category of this Object
type.
Reimplemented from DynExp::InstrumentBase.
|
pure virtualnoexcept |
Returns the stage's default velocity in nm/s if the stage supports SI units, in steps/s otherwise.
Implemented in DynExpInstr::SmarAct, DynExpInstr::PI_C_862, and DynExpInstr::NenionLeakvalveF3.
|
pure virtualnoexcept |
Returns the maximal position the stage can move to in nm if the stage supports SI units, in step units otherwise.
Implemented in DynExpInstr::SmarAct, DynExpInstr::PI_C_862, and DynExpInstr::NenionLeakvalveF3.
|
pure virtualnoexcept |
Returns the maximal velocity the stage can move with in nm/s if the stage supports SI units, in steps/s otherwise.
Implemented in DynExpInstr::SmarAct, DynExpInstr::PI_C_862, and DynExpInstr::NenionLeakvalveF3.
|
pure virtualnoexcept |
Returns the minimal position the stage can move to in nm if the stage supports SI units, in step units otherwise.
Implemented in DynExpInstr::SmarAct, DynExpInstr::PI_C_862, and DynExpInstr::NenionLeakvalveF3.
|
pure virtualnoexcept |
Returns the minimal velocity the stage can move with in nm/s if the stage supports SI units, in steps/s otherwise.
Implemented in DynExpInstr::SmarAct, DynExpInstr::PI_C_862, and DynExpInstr::NenionLeakvalveF3.
|
inlineoverridevirtual |
Returns the name of this Object
type.
Implements DynExp::Object.
Reimplemented in DynExpInstr::SmarAct, DynExpInstr::PI_C_862, and DynExpInstr::NenionLeakvalveF3.
|
pure virtualnoexcept |
Returns the stage's position resolution (precision) in nm if the stage supports SI units, in step units otherwise.
Implemented in DynExpInstr::SmarAct, DynExpInstr::PI_C_862, and DynExpInstr::NenionLeakvalveF3.
|
inlinevirtualnoexcept |
Determines the conversion factor in between internal PositionerStageData::PositionType positiond and velocities and the units the underlying hardware expects.
Reimplemented in DynExpInstr::SmarAct.
|
inlineoverridevirtual |
Specifies in which time intervals the instrument's task queue runs to handle pending tasks.
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::NenionLeakvalveF3.
|
inlinevirtualnoexcept |
Determines whether the underlying hardware expects SI units for positions and velocities or arbitrary units.
Reimplemented in DynExpInstr::SmarAct.
|
pure virtual |
Moves the positioner to an absolute position in its native units. Do divide units of PositionerStageData::Position by GetStepNanoMeterRatio()
to obtain native units. Also refer to IsUsingSIUnits()
.
Steps | Absolute position in the positioner's native units |
CallbackFunc | This 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::SmarAct, DynExpInstr::PI_C_862, and DynExpInstr::NenionLeakvalveF3.
|
pure virtual |
Moves the positioner to a position relative to its current position. The position offset Steps
has to be specified in native units. Do divide units of PositionerStageData::Position by GetStepNanoMeterRatio()
to obtain native units. Also refer to IsUsingSIUnits()
.
Steps | Relative position in the positioner's native units |
CallbackFunc | This 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::SmarAct, DynExpInstr::PI_C_862, and DynExpInstr::NenionLeakvalveF3.
|
virtual |
Moves the positioner to its stored home position. Also refer to SetHome()
.
CallbackFunc | This 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). |
Util::NotImplementedException | is thrown by the default implementation, which does not do anything more. |
Reimplemented in DynExpInstr::SmarAct, DynExpInstr::PI_C_862, and DynExpInstr::NenionLeakvalveF3.
|
inlinestaticconstexprnoexcept |
|
virtual |
References the positioner such that it finds its zero position or end stop.
Direction | Direction to move into to find the reference mark. This argument might be ignored. |
CallbackFunc | This 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). |
Util::NotImplementedException | is thrown by the default implementation, which does not do anything more. |
Reimplemented in DynExpInstr::PI_C_862.
|
finaloverrideprivate |
|
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::SmarAct, DynExpInstr::PI_C_862, and DynExpInstr::NenionLeakvalveF3.
|
virtual |
Stores the positioner's home position. Also refer to MoveToHome()
.
Util::NotImplementedException | is thrown by the default implementation, which does not do anything more. |
Reimplemented in DynExpInstr::SmarAct, DynExpInstr::PI_C_862, and DynExpInstr::NenionLeakvalveF3.
|
pure virtual |
Sets the positioner's velocity in its native units. Do divide units of PositionerStageData::Velocity by GetStepNanoMeterRatio()
to obtain native units. Also refer to IsUsingSIUnits()
.
Velocity | Velocity in the positioner's native units |
Implemented in DynExpInstr::SmarAct, DynExpInstr::PI_C_862, and DynExpInstr::NenionLeakvalveF3.
|
pure virtual |
Stops any motion or position stabilization of the positioner immediately.
Implemented in DynExpInstr::SmarAct, DynExpInstr::PI_C_862, and DynExpInstr::NenionLeakvalveF3.