Trigger |
Manages trigger based update operations. See remarks for details.
Inheritance HierarchyNamespace: Altaxo.Main
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3261.0 (4.8.3261.0)
SyntaxC#
public class TriggerBasedUpdate : DisposableBase
The TriggerBasedUpdate type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | TriggerBasedUpdate | Initializes a new instance of the TriggerBasedUpdate class. After creating this instance, set some of the timing parameters, and then subscribe to the UpdateAction event. This will activate the instance. |
Properties| Name | Description | |
|---|---|---|
 | MaximumWaitingTimeAfterFirstTrigger | MaximumWaitingTimeAfterFirstTrigger (default: Infinity): designates the maximum waiting time after the first trigger (after an update) occured. If this time has elapsed, a new update operation will be executed. |
| MaximumWaitingTimeAfterUpdate | MaximumWaitingTimeAfterUpdate (default: Infinity): designates the maximum time that must be waited after an update operation was executed. Normally infinity. If set to another value, it can be used to 'poll' the update operation. |
| MinimumWaitingTimeAfterFirstTrigger | MinimumWaitingTimeAfterFirstTrigger (default: Zero): designates the minimum time interval that should at least be waited after the first trigger (after an update) and the next update operation. |
| MinimumWaitingTimeAfterLastTrigger | MinimumWaitingTimeAfterLastTrigger (default: Zero): designates the time interval that at least should be waited between the latest occured trigger (after an update) and the next update operation. |
| MinimumWaitingTimeAfterUpdate | MinimumWaitingTimeAfterUpdate (default: Zero) designates the minimum time that must be waited after an update operation was executed. This parameter has the highest priority. |
Methods| Name | Description | |
|---|---|---|
| Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from DisposableBase) |
 | Dispose(Boolean) | Releases the unmanaged resources used by the TriggerBasedUpdate and optionally releases the managed resources (Overrides DisposableBaseDispose(Boolean)) |
| EhTimerElapsed | Called by the timer queue if our timer has elapsed. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize |
Finalizes an instance of the DisposableBase class.
(Inherited from DisposableBase) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| InternalGetDueTimeNoLock | Calculates the due time of the next update operation. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| Trigger | Triggers an update operation. The time the update operation is executed after this trigger depends on the parameters set in this instance. |
Events| Name | Description | |
|---|---|---|
 | UpdateAction |
Fields| Name | Description | |
|---|---|---|
 | _updateAction |
Remarks
An update is triggered by calling the Trigger function. The update is not executed immediately. Instead, depending on five timing parameters set in this instance,
it is delayed by a certain amount of time.
Five parameters control the behaviour of trigger base update operations:
- MinimumWaitingTimeAfterFirstTrigger (default: Zero): designates the minimum time interval that should at least be waited after the first trigger (after an update) and the next update operation.
- MaximumWaitingTimeAfterFirstTrigger (default: Infinity): designates the maximum waiting time after the first trigger (after an update) occured. If this time has elapsed, a new update operation will be executed.
- MinimumWaitingTimeAfterLastTrigger (default: Zero): designates the time interval that at least should be waited between the latest occured trigger (after an update) and the next update operation.
- MinimumWaitingTimeAfterUpdate (default: Zero) designates the minimum time that must be waited after an update operation was executed. This parameter has the highest priority.
- MaximumWaitingTimeAfterUpdate (default: Infinity): designates the maximum time that must be waited after an update operation was executed. Normally infinity. If set to another value, it can be used to 'poll' the update operation.
See Also