 |
itom
|
|
itom
|
abstract base class for dock widgets (toolboxes) of plugins More...
#include <abstractAddInDockWidget.h>
Public Types | |
| enum | MessageLevel { msgLevelNo = 0 , msgLevelErrorOnly = 1 , msgLevelWarningOnly = 2 , msgLevelWarningAndError = msgLevelErrorOnly | msgLevelWarningOnly } |
Public Slots | |
| virtual void | parametersChanged (QMap< QString, ito::Param > params)=0 |
| slot invoked if any parameter of the plugin has been changed. | |
| virtual void | identifierChanged (const QString &identifier)=0 |
| slot invoked if identifier of plugin has been set using AddInBase::setIdentifier | |
| virtual void | actuatorStatusChanged (QVector< int > status, QVector< double > actPosition) |
| slot invoked if the status or current position of an actuator plugin has been changed | |
| virtual void | targetChanged (QVector< double > targetPositions) |
| slot invoked if the target position of an actuator plugin has been changed | |
Public Member Functions | |
| AbstractAddInDockWidget (ito::AddInBase *plugin) | |
| constructor. | |
| virtual | ~AbstractAddInDockWidget () |
| destructor | |
Protected Member Functions | |
| ito::RetVal | setPluginParameter (QSharedPointer< ito::ParamBase > param, MessageLevel msgLevel=msgLevelWarningAndError) const |
| invokes AddInBase::setParam of plugin in order to set the given parameter | |
| ito::RetVal | setPluginParameters (const QVector< QSharedPointer< ito::ParamBase > > params, MessageLevel msgLevel=msgLevelWarningAndError) const |
| invokes AddInBase::setParamVector of plugin in order to set multiple given parameters | |
| ito::RetVal | observeInvocation (ItomSharedSemaphore *waitCond, MessageLevel msgLevel) const |
| observes the status of the given semaphore and returns after the semaphore has been released or a timeout occurred | |
| ito::RetVal | setActuatorPosition (QVector< int > axes, QVector< double > positions, bool relNotAbs, MessageLevel msgLevel=msgLevelWarningAndError) const |
| invokes AddInActuator::setPosRel or AddInActuator::setPosAbs of plugin in order to force a movement of one or multiple axes | |
| ito::RetVal | setActuatorPosition (int axis, double position, bool relNotAbs, MessageLevel msgLevel=msgLevelWarningAndError) const |
| invokes AddInActuator::setPosRel or AddInActuator::setPosAbs of plugin in order to force a movement of one axis | |
| ito::RetVal | setActuatorInterrupt () const |
| method to immediately set the interrupt flag of the actuator | |
| ito::RetVal | requestActuatorStatusAndPositions (bool sendCurrentPos, bool sendTargetPos, MessageLevel msgLevel=msgLevelWarningAndError) const |
| method to request the current status, positions and target positions from the actuator plugin | |
Private Attributes | |
| AbstractAddInDockWidgetPrivate * | d |
abstract base class for dock widgets (toolboxes) of plugins
Inherit your plugin's dock widget from this class in order to benefit from many simplified and unified processes. Since the plugin runs in its own thread while the dock widget runs in the main thread, the communication between the plugin and its dock widget needs to be done via signal/slot connections or general invocations.
The methods of this class help in this process.
Communication plugin -> dock widget:
Communication dock widget -> plugin:
MessageLevel enumeration defines whether warnings and/or errors that might occur during some executions should be displayed with a message box.
|
virtualslot |
slot invoked if the status or current position of an actuator plugin has been changed
overload this method if you want to react on such changes. Usually this slot is only connected in the dockWidgetVisibilityChanged method of an actuator plugin.
You don't need to overload this in non-actuator plugin based dock widgets.
| status | vector with status values for each axis (usually corresponds to ito::AddInActuator::m_currentStatus) |
| actPosition | vector with current position values (absolute in mm or degree). This vector can also be empty, if only status values have been changed. (usually corresponds to ito::AddInActuator::m_currentPos) |
|
pure virtualslot |
slot invoked if identifier of plugin has been set using AddInBase::setIdentifier
overload this method in order to get the identifier of the plugin. Usually, this identifier is only set in the init-method of the plugin, hence, after construction of the dock widget. Therefore this slot is invoked once the identifier has been changed.
| identifier | new identifier name of the plugin |
|
protected |
observes the status of the given semaphore and returns after the semaphore has been released or a timeout occurred
This helper method is mainly called by setPluginParameter or setPluginParameters in order to wait until the parameters have been set within the plugin. The corresponding return value is obtained and returned or displayed in a message box (if desired).
Directly call this method after having invoked any other slot where an instance of ItomSharedSemaphore has been passed as wait condition. This method returns if the wait condition has been released by the receiver, if the invocation failed or if a timeout occurred. For any possible timeout the AddInBase::isAlive flag is continuously evaluated.
| waitCond | is the wait condition passed to the invokeMethod command. |
| msgLevel | defines if any warnings or errors should be displayed within an appropriate message box. |
|
pure virtualslot |
slot invoked if any parameter of the plugin has been changed.
private data pointer of this class.
overload this method in order reset the widgets depending on the current states of the parameter. The first invocation can also be used in order to configure the dock widget depending on the current set of available parameters.
\params map of parameters (usually equal to m_params member of ito::AddInBase)
|
protected |
method to request the current status, positions and target positions from the actuator plugin
This method invokes the slot requestStatusAndPosition of the actuator plugin, that should get the current status, positions and target positions and emit these. Finally, the slots targetChanged and actuatorStatusChanged (depending on the boolean arguments) of this dock widget are called by means of a callback.
|
protected |
method to immediately set the interrupt flag of the actuator
Call this method in order to thread-safely and intermediately set the interrupt flag of the actuator.
The actuator should check this flag with isInterrupted() and stop the movement if possible.
|
protected |
invokes AddInActuator::setPosRel or AddInActuator::setPosAbs of plugin in order to force a movement of one axis
Use this method to thread-safely position one axis of an actuator plugin. Do not directly call setPosRel or setPosAbs of the plugin, since this is not thread safe.
This method waits until the movement ended (if the movement has been configured to by synchronous, plugin parameter)
| axis | is the index of the axis (zero-based) |
| position | is the relative or absolute position in mm or degree |
| relNotAbs | indicates a relative movement if true, else an absolute movement |
| msgLevel | defines if any warnings or errors should be displayed within an appropriate message box. |
|
protected |
invokes AddInActuator::setPosRel or AddInActuator::setPosAbs of plugin in order to force a movement of one or multiple axes
Use this method to thread-safely position one or multiple axes of an actuator plugin. Do not directly call setPosRel or setPosAbs of the plugin, since this is not thread safe.
This method waits until the movement ended (if the movement has been configured to by synchronous, plugin parameter)
| axes | is a vector of axes indices (zero-based) |
| positions | are the relative or absolute positions (vector with the same length than axes) in mm or degree |
| relNotAbs | indicates a relative movement if true, else an absolute movement |
| msgLevel | defines if any warnings or errors should be displayed within an appropriate message box. |
|
protected |
invokes AddInBase::setParam of plugin in order to set the given parameter
Use this method to thread-safely set any desired parameter of the plugin. No direct call of setParam of the plugin is possible since the plugin usually runs in a secondary thread.
| param | is the parameter to set. |
| msgLevel | defines if any warnings or errors should be displayed within an appropriate message box. |
|
protected |
invokes AddInBase::setParamVector of plugin in order to set multiple given parameters
Use this method to thread-safely set any desired parameters of the plugin. No direct call of setParam or setParamVector of the plugin is possible since the plugin usually runs in a secondary thread.
| params | is a vector of parameters to set. |
| msgLevel | defines if any warnings or errors should be displayed within an appropriate message box. |
|
virtualslot |
slot invoked if the target position of an actuator plugin has been changed
overload this method if you want to react on such changes. Usually this slot is only connected in the dockWidgetVisibilityChanged method of an actuator plugin.
You don't need to overload this in non-actuator plugin based dock widgets.
| targetPositions | is the vector of target positions (in mm or degree). Usually this corresponds to the member ito::AddInActuator::m_targetPos |
1.12.0