ISequence
- Namespace
- ZCore
Interface to the Zeugwerk Framework Sequence function block which defines the basic methods that have to be implemented.
To run a sequence and start it from the beginning this can be done and should be implemented by using RunAsync. There, a cancellation token can be used to check could be started successfully. A running sequence can be stopped by calling Stop method.
INTERFACE ISequence EXTENDS ZCore.IObject, ZCore.IError, ZCore.ICancellationToken, ZCore.IHaltable, ZCore.IStartToken, ZCore.IHaltToken
- Extends
- Inherited Properties
- Inherited Methods
Properties
MilestoneActive
This method returns TRUE once a sequence uses a milestone
PROPERTY MilestoneActive : BOOL
Property Value
- BOOL
Methods
Cyclic
Usually sequences are implemented in the body of the function block. This is mor convenient for most of the PLC programmers out there and has some performance advantages. To be compatible to all other object oriented features of the Zeugwerk Framework this Cyclic method will call the function blocks body and therefore runs the sequence. It is necessary to do this in order to get a sequence to work by using an object manager
METHOD Cyclic ()
Name
Returns the name of this sequence as it has been set by SetName
METHOD Name () : ZString
Returns
RunAsync
With this method a sequence can be started. It is possible to provide a cancellationToken to check if the sequence
was started properly without any errors and/or to halt the sequence prematurely by setting cancellationToken.Halting := TRUE.
METHOD RunAsync (
cancellationToken : ICancellationToken)
Inputs
cancellationTokenICancellationTokenToken to check if starting the sequence worked out properly and to request prematurely halt
Stop
This method stops a running sequence immediately.
METHOD Stop ()