Inheritance diagram for DynExpInstr::SmarAct:

Public Types
using	ParamsType = SmarActParams

using	ConfigType = SmarActConfigurator

using	InstrumentDataType = SmarActData

Public Types inherited from DynExpInstr::PositionerStage
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...

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
	SmarAct (const std::thread::id OwnerThreadID, DynExp::ParamsBasePtrType &&Params)

virtual	~SmarAct ()

virtual std::string	GetName () const override
	Returns the name of this `Object` type. More...

virtual PositionerStageData::PositionType	GetMinPosition () const noexcept override
	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 override
	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 override
	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 override
	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 override
	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 override
	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 override
	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 override
	Determines whether the underlying hardware expects SI units for positions and velocities or arbitrary units. More...

virtual void	SetHome () const override
	Stores the positioner's home position. Also refer to `MoveToHome()`. More...

virtual void	Reference ([[maybe_unused]] DirectionType Direction=DirectionType::Forward, DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const override

virtual void	Calibrate (DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const override
	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 (PositionerStageData::PositionType Velocity) const override
	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 override
	Moves the positioner to its stored home position. Also refer to `SetHome()`. More...

virtual void	MoveAbsolute (PositionerStageData::PositionType Position, DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const override
	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 (PositionerStageData::PositionType Position, DynExp::TaskBase::CallbackType CallbackFunc=nullptr) const override
	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 override
	Stops any motion or position stabilization of the positioner immediately. More...

Public Member Functions inherited from DynExpInstr::PositionerStage
	PositionerStage (const std::thread::id OwnerThreadID, DynExp::ParamsBasePtrType &&Params)
	Constructs an instrument instance. More...

virtual	~PositionerStage ()=0

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...

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...

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

Static Public Member Functions inherited from DynExpInstr::PositionerStage
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
virtual void	OnErrorChild () const override
	Derived classes can perform critical shutdown actions after an error has occurred. Override `OnErrorChild()` to adjust behavior. More...

void	ResetImpl (dispatch_tag< PositionerStage >) 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< SmarAct >)

virtual std::unique_ptr< DynExp::InitTaskBase >	MakeInitTask () 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::ExitTaskBase >	MakeExitTask () 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::UpdateTaskBase >	MakeUpdateTask () 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...

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

Definition at line 208 of file SmarAct.h.

Member Typedef Documentation

◆ ConfigType

using DynExpInstr::SmarAct::ConfigType = SmarActConfigurator

Definition at line 212 of file SmarAct.h.

◆ InstrumentDataType

using DynExpInstr::SmarAct::InstrumentDataType = SmarActData

Definition at line 213 of file SmarAct.h.

◆ ParamsType

using DynExpInstr::SmarAct::ParamsType = SmarActParams

Definition at line 211 of file SmarAct.h.

Constructor & Destructor Documentation

◆ SmarAct()

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

Definition at line 164 of file SmarAct.cpp.

◆ ~SmarAct()

virtual DynExpInstr::SmarAct::~SmarAct ( )

inlinevirtual

Definition at line 218 of file SmarAct.h.

Member Function Documentation

◆ Calibrate()

virtual void DynExpInstr::SmarAct::Calibrate ( DynExp::TaskBase::CallbackType CallbackFunc = nullptr ) const

inlineoverridevirtual

Calibrates the positioner. The meaning of such a calibration is solely specified by the hardware manufacturer of the respective positioner type.

Parameters

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).

Exceptions

Util::NotImplementedException is thrown by the default implementation, which does not do anything more.

Reimplemented from DynExpInstr::PositionerStage.

Definition at line 233 of file SmarAct.h.

◆ GetDefaultVelocity()

virtual PositionerStageData::PositionType DynExpInstr::SmarAct::GetDefaultVelocity ( ) const

inlineoverridevirtualnoexcept

Returns the stage's default velocity in nm/s if the stage supports SI units, in steps/s otherwise.

Implements DynExpInstr::PositionerStage.

Definition at line 227 of file SmarAct.h.

◆ GetMaxPosition()

virtual PositionerStageData::PositionType DynExpInstr::SmarAct::GetMaxPosition ( ) const

inlineoverridevirtualnoexcept

Returns the maximal position the stage can move to in nm if the stage supports SI units, in step units otherwise.

Implements DynExpInstr::PositionerStage.

Definition at line 223 of file SmarAct.h.

◆ GetMaxVelocity()

virtual PositionerStageData::PositionType DynExpInstr::SmarAct::GetMaxVelocity ( ) const

inlineoverridevirtualnoexcept

Returns the maximal velocity the stage can move with in nm/s if the stage supports SI units, in steps/s otherwise.

Implements DynExpInstr::PositionerStage.

Definition at line 226 of file SmarAct.h.

◆ GetMinPosition()

virtual PositionerStageData::PositionType DynExpInstr::SmarAct::GetMinPosition ( ) const

inlineoverridevirtualnoexcept

Returns the minimal position the stage can move to in nm if the stage supports SI units, in step units otherwise.

Implements DynExpInstr::PositionerStage.

Definition at line 222 of file SmarAct.h.

◆ GetMinVelocity()

virtual PositionerStageData::PositionType DynExpInstr::SmarAct::GetMinVelocity ( ) const

inlineoverridevirtualnoexcept

Returns the minimal velocity the stage can move with in nm/s if the stage supports SI units, in steps/s otherwise.

Implements DynExpInstr::PositionerStage.

Definition at line 225 of file SmarAct.h.

◆ GetName()

virtual std::string DynExpInstr::SmarAct::GetName ( ) const

inlineoverridevirtual

Returns the name of this Object type.

Reimplemented from DynExpInstr::PositionerStage.

Definition at line 220 of file SmarAct.h.

◆ GetResolution()

virtual PositionerStageData::PositionType DynExpInstr::SmarAct::GetResolution ( ) const

inlineoverridevirtualnoexcept

Returns the stage's position resolution (precision) in nm if the stage supports SI units, in step units otherwise.

Implements DynExpInstr::PositionerStage.

Definition at line 224 of file SmarAct.h.

◆ GetStepNanoMeterRatio()

virtual double DynExpInstr::SmarAct::GetStepNanoMeterRatio ( ) const

inlineoverridevirtualnoexcept

Determines the conversion factor in between internal PositionerStageData::PositionType positiond and velocities and the units the underlying hardware expects.

Returns: Returns a factor positions and velocities are divided by before sending the values to the hardware. This is useful if the underlying hardware e.g. operates in mm instead of nm.

Reimplemented from DynExpInstr::PositionerStage.

Definition at line 228 of file SmarAct.h.

◆ IsUsingSIUnits()

virtual bool DynExpInstr::SmarAct::IsUsingSIUnits ( ) const

inlineoverridevirtualnoexcept

Determines whether the underlying hardware expects SI units for positions and velocities or arbitrary units.

Returns: Return true if the underlying hardware deals with SI units, false otherwise.

Reimplemented from DynExpInstr::PositionerStage.

Definition at line 229 of file SmarAct.h.

◆ MakeExitTask()

virtual std::unique_ptr<DynExp::ExitTaskBase> DynExpInstr::SmarAct::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 DynExp::InstrumentBase.

Definition at line 248 of file SmarAct.h.

◆ MakeInitTask()

virtual std::unique_ptr<DynExp::InitTaskBase> DynExpInstr::SmarAct::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 DynExp::InstrumentBase.

Definition at line 247 of file SmarAct.h.

◆ MakeUpdateTask()

virtual std::unique_ptr<DynExp::UpdateTaskBase> DynExpInstr::SmarAct::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 DynExp::InstrumentBase.

Definition at line 249 of file SmarAct.h.

◆ MoveAbsolute()

virtual void DynExpInstr::SmarAct::MoveAbsolute	(	PositionerStageData::PositionType	Steps,
		DynExp::TaskBase::CallbackType	CallbackFunc = `nullptr`
	)		const

inlineoverridevirtual

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().

Parameters

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).

Implements DynExpInstr::PositionerStage.

Definition at line 237 of file SmarAct.h.

◆ MoveRelative()

virtual void DynExpInstr::SmarAct::MoveRelative	(	PositionerStageData::PositionType	Steps,
		DynExp::TaskBase::CallbackType	CallbackFunc = `nullptr`
	)		const

inlineoverridevirtual

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().

Parameters

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).

Implements DynExpInstr::PositionerStage.

Definition at line 238 of file SmarAct.h.

◆ MoveToHome()

virtual void DynExpInstr::SmarAct::MoveToHome ( DynExp::TaskBase::CallbackType CallbackFunc = nullptr ) const

inlineoverridevirtual

Moves the positioner to its stored home position. Also refer to SetHome().

Parameters

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).

Exceptions

Util::NotImplementedException is thrown by the default implementation, which does not do anything more.

Reimplemented from DynExpInstr::PositionerStage.

Definition at line 236 of file SmarAct.h.

◆ Name()

constexpr static auto DynExpInstr::SmarAct::Name ( )

inlinestaticconstexprnoexcept

Definition at line 215 of file SmarAct.h.

◆ OnErrorChild()

void DynExpInstr::SmarAct::OnErrorChild ( ) const

overrideprivatevirtual

Derived classes can perform critical shutdown actions after an error has occurred. Override OnErrorChild() to adjust behavior.

Reimplemented from DynExp::InstrumentBase.

Definition at line 169 of file SmarAct.cpp.

◆ Reference()

virtual void DynExpInstr::SmarAct::Reference	(	[[maybe_unused] ] DirectionType	Direction = `DirectionType::Forward`,
		DynExp::TaskBase::CallbackType	CallbackFunc = `nullptr`
	)		const

inlineoverridevirtual

Definition at line 232 of file SmarAct.h.

◆ ResetImpl() [1/2]

void DynExpInstr::SmarAct::ResetImpl ( dispatch_tag< PositionerStage > )

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::PositionerStage.

Definition at line 177 of file SmarAct.cpp.

◆ ResetImpl() [2/2]

virtual void DynExpInstr::SmarAct::ResetImpl ( dispatch_tag< SmarAct > )

inlineprivatevirtual

Definition at line 245 of file SmarAct.h.

◆ SetHome()

virtual void DynExpInstr::SmarAct::SetHome ( ) const

inlineoverridevirtual

Stores the positioner's home position. Also refer to MoveToHome().

Exceptions

Util::NotImplementedException is thrown by the default implementation, which does not do anything more.

Reimplemented from DynExpInstr::PositionerStage.

Definition at line 231 of file SmarAct.h.

◆ SetVelocity()

virtual void DynExpInstr::SmarAct::SetVelocity ( PositionerStageData::PositionType Velocity ) const

inlineoverridevirtual

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().

Parameters

Velocity Velocity in the positioner's native units

Implements DynExpInstr::PositionerStage.

Definition at line 234 of file SmarAct.h.

◆ StopMotion()

virtual void DynExpInstr::SmarAct::StopMotion ( ) const

inlineoverridevirtual

Stops any motion or position stabilization of the positioner immediately.

Implements DynExpInstr::PositionerStage.

Definition at line 239 of file SmarAct.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ConfigType

◆ InstrumentDataType

◆ ParamsType

Constructor & Destructor Documentation

◆ SmarAct()

◆ ~SmarAct()

Member Function Documentation

◆ Calibrate()

◆ GetDefaultVelocity()

◆ GetMaxPosition()

◆ GetMaxVelocity()

◆ GetMinPosition()

◆ GetMinVelocity()

◆ GetName()

◆ GetResolution()

◆ GetStepNanoMeterRatio()

◆ IsUsingSIUnits()

◆ MakeExitTask()

◆ MakeInitTask()

◆ MakeUpdateTask()

◆ MoveAbsolute()

◆ MoveRelative()

◆ MoveToHome()

◆ Name()

◆ OnErrorChild()

◆ Reference()

◆ ResetImpl() [1/2]

◆ ResetImpl() [2/2]

◆ SetHome()

◆ SetVelocity()

◆ StopMotion()