Click or drag to resize

TriggerBasedUpdate Class

Manages trigger based update operations. See remarks for details.
Inheritance Hierarchy
SystemObject
  AltaxoDisposableBase
    Altaxo.MainTriggerBasedUpdate

Namespace: Altaxo.Main
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3179.0 (4.8.3179.0)
Syntax
C#
public class TriggerBasedUpdate : DisposableBase

The TriggerBasedUpdate type exposes the following members.

Constructors
 NameDescription
Public methodTriggerBasedUpdate 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.
Top
Properties
 NameDescription
Public propertyMaximumWaitingTimeAfterFirstTrigger 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.
Public propertyMaximumWaitingTimeAfterUpdate 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.
Public propertyMinimumWaitingTimeAfterFirstTrigger 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.
Public propertyMinimumWaitingTimeAfterLastTrigger 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.
Public propertyMinimumWaitingTimeAfterUpdate MinimumWaitingTimeAfterUpdate (default: Zero) designates the minimum time that must be waited after an update operation was executed. This parameter has the highest priority.
Top
Methods
 NameDescription
Public methodDispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from DisposableBase)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the TriggerBasedUpdate and optionally releases the managed resources
(Overrides DisposableBaseDispose(Boolean))
Protected methodEhTimerElapsed Called by the timer queue if our timer has elapsed.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Finalizes an instance of the DisposableBase class.
(Inherited from DisposableBase)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodInternalGetDueTimeNoLock Calculates the due time of the next update operation.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodTrigger Triggers an update operation. The time the update operation is executed after this trigger depends on the parameters set in this instance.
Top
Events
 NameDescription
Public eventUpdateAction 
Top
Fields
 NameDescription
Public field_updateAction 
Top
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