Inheritance diagram for DynExpHardware::SmarActHardwareAdapter:

Public Types
using	ParamsType = SmarActHardwareAdapterParams

using	ConfigType = SmarActHardwareAdapterConfigurator

using	ChannelType = int8_t

using	PositionType = int64_t

using	DirectionType = DynExpInstr::PositionerStage::DirectionType

Public Types inherited from DynExp::HardwareAdapterBase
using	ParamsType = HardwareAdapterParamsBase
	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 = HardwareAdapterConfiguratorBase
	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
	SmarActHardwareAdapter (const std::thread::id OwnerThreadID, DynExp::ParamsBasePtrType &&Params)

virtual	~SmarActHardwareAdapter ()

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

bool	IsOpened () const noexcept

PositionType	GetCurrentPosition (const ChannelType Channel) const

PositionType	GetTargetPosition (const ChannelType Channel) const

PositionType	GetVelocity (const ChannelType Channel) const

int32_t	GetChannelState (const ChannelType Channel) const

void	Calibrate (const ChannelType Channel) const

void	Reference (const ChannelType Channel) const

void	SetVelocity (const ChannelType Channel, PositionType Velocity) const

void	MoveAbsolute (const ChannelType Channel, PositionType Position) const

void	MoveRelative (const ChannelType Channel, PositionType Position) const

void	StopMotion (const ChannelType Channel) const

Public Member Functions inherited from DynExp::HardwareAdapterBase
	HardwareAdapterBase (const std::thread::id OwnerThreadID, ParamsBasePtrType &&Params)
	Constructs a hardware adapter instance. More...

virtual	~HardwareAdapterBase ()=0

void	ResetException () const
	Sets LastException to nullptr in a thread-safe way. More...

bool	IsConnected () const noexcept
	Determines the connection status of the hardware interface. 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

constexpr static auto	Category () noexcept

static auto	Enumerate ()

Static Public Member Functions inherited from DynExp::HardwareAdapterBase
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	Init ()

void	ResetImpl (dispatch_tag< HardwareAdapterBase >) override final

virtual void	ResetImpl (dispatch_tag< SmarActHardwareAdapter >)

void	EnsureReadyStateChild () override final
	Ensures that this `Object` instance is ready by possibly starting its worker thread or by opening connections to hardware devices. More...

bool	IsReadyChild () const override final
	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...

bool	IsConnectedChild () const noexcept override final
	Determines the connection status of the hardware interface. More...

void	CheckError (const SmarActSyms::SA_CTL_Result_t Result, const std::source_location Location=std::source_location::current()) const

void	OpenUnsafe ()

void	CloseUnsafe ()

Private Attributes
std::string	DeviceDescriptor

std::atomic< bool >	SmarActHandleValid

SmarActSyms::SA_CTL_DeviceHandle_t	SmarActHandle

Additional Inherited Members
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::HardwareAdapterBase
static constexpr auto	ShortTimeoutDefault = std::chrono::milliseconds(10)
	Default timeout e.g. used as a default for calls to Object::GetException(). More...

static constexpr auto	HardwareOperationTimeout = std::chrono::milliseconds(100)
	Default timeout used to lock the mutex provided by the base class Util::ILockable to synchronize access to the hardware interface in between multiple instrument threads. More...

Static Public Attributes inherited from Util::ILockable
static constexpr std::chrono::milliseconds	DefaultTimeout = std::chrono::milliseconds(10)
	Duration which is used as a default timeout within all methods of this class if no different duration is passed to them. 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 Types inherited from Util::ILockable
using	MutexType = std::timed_mutex

using	LockType = std::unique_lock< MutexType >

Protected Member Functions inherited from DynExp::HardwareAdapterBase
void	ThrowException (std::exception_ptr Exception) const
	Stores `Exception` in LastException, wraps it in a Util::ForwardedException and throws the wrapped excetion by calling Util::ForwardException(). More...

void	ThrowExceptionUnsafe (std::exception_ptr Exception) const
	Stores `Exception` in LastException, wraps it in a Util::ForwardedException and throws the wrapped excetion by calling Util::ForwardException(). More...

void	SetExceptionUnsafe (std::exception_ptr Exception) const
	Stores `Exception` in LastException. More...

auto	GetExceptionUnsafe () const
	Getter for LastException. More...

Protected Member Functions inherited from Util::ILockable
	ILockable ()=default

	~ILockable ()=default

LockType	AcquireLock (const std::chrono::milliseconds Timeout=DefaultTimeout) const
	Locks the internal mutex. Blocks until the mutex is locked or until the timeout duration is exceeded. 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...

Detailed Description

Definition at line 62 of file HardwareAdapterSmarAct.h.

Member Typedef Documentation

◆ ChannelType

using DynExpHardware::SmarActHardwareAdapter::ChannelType = int8_t

Definition at line 68 of file HardwareAdapterSmarAct.h.

◆ ConfigType

using DynExpHardware::SmarActHardwareAdapter::ConfigType = SmarActHardwareAdapterConfigurator

Definition at line 66 of file HardwareAdapterSmarAct.h.

◆ DirectionType

using DynExpHardware::SmarActHardwareAdapter::DirectionType = DynExpInstr::PositionerStage::DirectionType

Definition at line 70 of file HardwareAdapterSmarAct.h.

◆ ParamsType

using DynExpHardware::SmarActHardwareAdapter::ParamsType = SmarActHardwareAdapterParams

Definition at line 65 of file HardwareAdapterSmarAct.h.

◆ PositionType

using DynExpHardware::SmarActHardwareAdapter::PositionType = int64_t

Definition at line 69 of file HardwareAdapterSmarAct.h.

Constructor & Destructor Documentation

◆ SmarActHardwareAdapter()

DynExpHardware::SmarActHardwareAdapter::SmarActHardwareAdapter	(	const std::thread::id	OwnerThreadID,
		DynExp::ParamsBasePtrType &&	Params
	)

Definition at line 51 of file HardwareAdapterSmarAct.cpp.

◆ ~SmarActHardwareAdapter()

DynExpHardware::SmarActHardwareAdapter::~SmarActHardwareAdapter ( )

virtual

Definition at line 57 of file HardwareAdapterSmarAct.cpp.

Member Function Documentation

◆ Calibrate()

void DynExpHardware::SmarActHardwareAdapter::Calibrate ( const ChannelType Channel ) const

Definition at line 184 of file HardwareAdapterSmarAct.cpp.

◆ Category()

constexpr static auto DynExpHardware::SmarActHardwareAdapter::Category ( )

inlinestaticconstexprnoexcept

Definition at line 73 of file HardwareAdapterSmarAct.h.

◆ CheckError()

void DynExpHardware::SmarActHardwareAdapter::CheckError	(	const SmarActSyms::SA_CTL_Result_t	Result,
		const std::source_location	Location = `std::source_location::current()`
	)		const

private

Definition at line 106 of file HardwareAdapterSmarAct.cpp.

◆ CloseUnsafe()

void DynExpHardware::SmarActHardwareAdapter::CloseUnsafe ( )

private

Definition at line 128 of file HardwareAdapterSmarAct.cpp.

◆ EnsureReadyStateChild()

void DynExpHardware::SmarActHardwareAdapter::EnsureReadyStateChild ( )

finaloverrideprivatevirtual

Ensures that this Object instance is ready by possibly starting its worker thread or by opening connections to hardware devices.

Implements DynExp::HardwareAdapterBase.

Definition at line 84 of file HardwareAdapterSmarAct.cpp.

◆ Enumerate()

auto DynExpHardware::SmarActHardwareAdapter::Enumerate ( )

static

Definition at line 8 of file HardwareAdapterSmarAct.cpp.

◆ GetCategory()

virtual std::string DynExpHardware::SmarActHardwareAdapter::GetCategory ( ) const

inlineoverridevirtual

Returns the category of this Object type.

Reimplemented from DynExp::HardwareAdapterBase.

Definition at line 80 of file HardwareAdapterSmarAct.h.

◆ GetChannelState()

int32_t DynExpHardware::SmarActHardwareAdapter::GetChannelState ( const ChannelType Channel ) const

Definition at line 173 of file HardwareAdapterSmarAct.cpp.

◆ GetCurrentPosition()

SmarActHardwareAdapter::PositionType DynExpHardware::SmarActHardwareAdapter::GetCurrentPosition ( const ChannelType Channel ) const

Definition at line 140 of file HardwareAdapterSmarAct.cpp.

◆ GetName()

virtual std::string DynExpHardware::SmarActHardwareAdapter::GetName ( ) const

inlineoverridevirtual

Returns the name of this Object type.

Implements DynExp::Object.

Definition at line 79 of file HardwareAdapterSmarAct.h.

◆ GetTargetPosition()

SmarActHardwareAdapter::PositionType DynExpHardware::SmarActHardwareAdapter::GetTargetPosition ( const ChannelType Channel ) const

Definition at line 151 of file HardwareAdapterSmarAct.cpp.

◆ GetVelocity()

SmarActHardwareAdapter::PositionType DynExpHardware::SmarActHardwareAdapter::GetVelocity ( const ChannelType Channel ) const

Definition at line 162 of file HardwareAdapterSmarAct.cpp.

◆ Init()

void DynExpHardware::SmarActHardwareAdapter::Init ( )

private

Definition at line 63 of file HardwareAdapterSmarAct.cpp.

◆ IsConnectedChild()

bool DynExpHardware::SmarActHardwareAdapter::IsConnectedChild ( ) const

finaloverrideprivatevirtualnoexcept

Determines the connection status of the hardware interface.

Returns: Returns true when the hardware adapter is connected to the physical hardware device, false otherwise.

Implements DynExp::HardwareAdapterBase.

Definition at line 101 of file HardwareAdapterSmarAct.cpp.

◆ IsOpened()

bool DynExpHardware::SmarActHardwareAdapter::IsOpened ( ) const

inlinenoexcept

Definition at line 82 of file HardwareAdapterSmarAct.h.

◆ IsReadyChild()

bool DynExpHardware::SmarActHardwareAdapter::IsReadyChild ( ) const

finaloverrideprivatevirtual

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

Returns: Returns true if this Object instance is ready, false otherwise.

Implements DynExp::Object.

Definition at line 91 of file HardwareAdapterSmarAct.cpp.

◆ MoveAbsolute()

void DynExpHardware::SmarActHardwareAdapter::MoveAbsolute	(	const ChannelType	Channel,
		PositionType	Position
	)		const

Definition at line 210 of file HardwareAdapterSmarAct.cpp.

◆ MoveRelative()

void DynExpHardware::SmarActHardwareAdapter::MoveRelative	(	const ChannelType	Channel,
		PositionType	Position
	)		const

Definition at line 221 of file HardwareAdapterSmarAct.cpp.

◆ Name()

constexpr static auto DynExpHardware::SmarActHardwareAdapter::Name ( )

inlinestaticconstexprnoexcept

Definition at line 72 of file HardwareAdapterSmarAct.h.

◆ OpenUnsafe()

void DynExpHardware::SmarActHardwareAdapter::OpenUnsafe ( )

private

Definition at line 117 of file HardwareAdapterSmarAct.cpp.

◆ Reference()

void DynExpHardware::SmarActHardwareAdapter::Reference ( const ChannelType Channel ) const

Definition at line 192 of file HardwareAdapterSmarAct.cpp.

◆ ResetImpl() [1/2]

void DynExpHardware::SmarActHardwareAdapter::ResetImpl ( dispatch_tag< HardwareAdapterBase > )

finaloverrideprivate

Definition at line 73 of file HardwareAdapterSmarAct.cpp.

◆ ResetImpl() [2/2]

virtual void DynExpHardware::SmarActHardwareAdapter::ResetImpl ( dispatch_tag< SmarActHardwareAdapter > )

inlineprivatevirtual

Definition at line 109 of file HardwareAdapterSmarAct.h.

◆ SetVelocity()

void DynExpHardware::SmarActHardwareAdapter::SetVelocity	(	const ChannelType	Channel,
		PositionType	Velocity
	)		const

Definition at line 202 of file HardwareAdapterSmarAct.cpp.

◆ StopMotion()

void DynExpHardware::SmarActHardwareAdapter::StopMotion ( const ChannelType Channel ) const

Definition at line 232 of file HardwareAdapterSmarAct.cpp.

Member Data Documentation

◆ DeviceDescriptor

std::string DynExpHardware::SmarActHardwareAdapter::DeviceDescriptor

private

Definition at line 121 of file HardwareAdapterSmarAct.h.

◆ SmarActHandle

SmarActSyms::SA_CTL_DeviceHandle_t DynExpHardware::SmarActHardwareAdapter::SmarActHandle

private

Definition at line 124 of file HardwareAdapterSmarAct.h.

◆ SmarActHandleValid

std::atomic<bool> DynExpHardware::SmarActHardwareAdapter::SmarActHandleValid

private

Definition at line 122 of file HardwareAdapterSmarAct.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ChannelType

◆ ConfigType

◆ DirectionType

◆ ParamsType

◆ PositionType

Constructor & Destructor Documentation

◆ SmarActHardwareAdapter()

◆ ~SmarActHardwareAdapter()

Member Function Documentation

◆ Calibrate()

◆ Category()

◆ CheckError()

◆ CloseUnsafe()

◆ EnsureReadyStateChild()

◆ Enumerate()

◆ GetCategory()

◆ GetChannelState()

◆ GetCurrentPosition()

◆ GetName()

◆ GetTargetPosition()

◆ GetVelocity()

◆ Init()

◆ IsConnectedChild()

◆ IsOpened()

◆ IsReadyChild()

◆ MoveAbsolute()

◆ MoveRelative()

◆ Name()

◆ OpenUnsafe()

◆ Reference()

◆ ResetImpl() [1/2]

◆ ResetImpl() [2/2]

◆ SetVelocity()

◆ StopMotion()

Member Data Documentation

◆ DeviceDescriptor

◆ SmarActHandle

◆ SmarActHandleValid