[PAProcessFunction] PAProcessFunction (developer guide)


  Document tree

;

Method Name/ID Class / Summary
Abort Void

Brings the process from any state to Aborted-State

Hold Void

Brings the process from Running-State to Hold-State

Pause Void

Brings the process from Running-State to Paused-State

Reset Void

Brings the process from Stopped- oder Aborted- or Completed-State to Idle-State

Reset2Repeat Void

Restart Void

Brings the process from Hold-State to Running-State

Resume Void

Brings the process from Paused-State to Running-State

SendChangedACMethod Void

Sends the parameters of CurrentACMethod to an external system (e.g. PLC)

SMAborted Void

Comes from SMAborting-State. Reset() will be called inside this method if callback to the invoking workflow-node has been sucessful. Possible follow-up states: SMResetting

SMAborting Void

Comes from SMRunning-State when user has invoked the Abort()-Method. Possible follow-up states: SMAborted

SMCompleted Void

Comes from SMRunning-State an signals that the process has completed. Reset() will be called inside this method if callback to the invoking workflow-node has been sucessful. Possible follow-up states: SMResetting

SMHeld Void

Comes from SMHolding-State. Restart() must be invoked from user to come back to the Running-State. Possible follow-up states: SMResuming

SMHolding Void

Comes from SMRunning-State when user has invoked the Hold()-Method. Possible follow-up states: SMPaused

SMPaused Void

Comes from SMPausing-State. Resume() must be invoked from user to come back to the Running-State. Possible follow-up states: SMResuming

SMPausing Void

Comes from SMRunning-State when user has invoked the Pause()-Method. Possible follow-up states: SMPaused

SMResetting Void

Comes from SMCompleted or SMStopped or SMAborted-State an signals that the callback to the invoking workflow-node has been done Possible follow-up states: SMIdle

SMRestarting Void

Comes from SMHeld-State. Possible follow-up states: SMRunning

SMResuming Void

Comes from SMPaused-State. Possible follow-up states: SMRunning

SMRunning Void

Comes from SMStarting-State an signals that the process is running. Possible follow-up states: SMCompleted SMAborted

SMStarting Void

If method "Start(ACMethod acMethod)" was sucessful, than the state-machine switches to SMStarting and invokes this cyclic method. Possible follow-up states: SMRunning: If ReSendACMethod() succeeds and parameters are send to a external system. SMIdle: If something went wrong and ACStateConverter has cancelled the process.

SMStopped Void

Comes from SMStopping-State. Reset() will be called inside this method if callback to the invoking workflow-node has been sucessful. Possible follow-up states: SMResetting

SMStopping Void

Comes from SMRunning-State when user has invoked the Stopp()-Method. Possible follow-up states: SMStopped

Start ACMethodEventArgs

Stopp Void

Brings the process from any state to Stopped-State Method is named "Stopp" (StopProcess) because Stop()-MEthod already exists in ACComponent


Method Name/ID Class / Summary
#cctor

AnalyzeACMethodResult(gip

This method is invoked when the function completes and ACStateConverter.ReceiveACMethodResult() has been called to get result-values from a external system (e.g. PLC). Override this method if you want to manipulate the ResultValue-List before the callback to the invoking workflow-node takes place. With returning the enum CompleteResult you can control if the callback should be done or not.

CallbackOnSMStarting

Callbacks the the invoking workflow-node and informs, that the task was either started/accepted or cancelled.

CallbackTaskBeforeResetting(gip

Invokes the callback-method of the workflow-node which started this asnychronous process.

CompleteACMethodOnSMStarting(gip

Before a Function can switch to the running state parameters has to be send to a external system (e.g. PLC). Before sending this method is called. Override this Method if you want to manipulate the parameters inside ACMethod before they are sended by ACStateConverter.SendACMethod(). This method is also invoked, when a user changes the parameterlist on the GUI on client-side.

CompleteResultAndCallback(gip

This method is invoked from SMCompleted(), SMAborted() or SMStopped() to read the results from an external system and invoke the calback-method of the workwflow-node which started this asynchronous process. 1. Reads the result from a external system via ACStateConverter.ReceiveACMethodResult(). 2. Checks if ReceiveACMethodResult() was sucessful by calling HandleFunctionErrorOnCallback(). 3. Analyzes the result by calling AnalyzeACMethodResult(). 4. Checks if AnalyzeACMethodResult() was sucessful by calling HandleFunctionErrorOnCallback() again. 5. Invokes CallbackTaskBeforeResetting().

GetCurrentACProgram(System

Only for internal usage! Use property CurrentACProgram.

HandleFunctionErrorOnCallback(gip

Handles the CompleteResult-State when ACStateConverter.ReceiveACMethodResult() and AnalyzeACMethodResult() was called.

InitializeRouteAndConfig(gip

This method is invoked when ApplicationManager.InitializeRouteAndConfig() is invoked from a user. Override this method if your function has to inititialize some Standard-Parameters for the Route-Configuration.

IsEnabledRun

This method is called inside SMStarting() to check if a remote system (e.g. PLC) is ready to start this Function. Only if this method returns true, ReSendACMethod() will be called. You can override this method if you want to implement some further checks.

IsEnabledStart(gip

Validates the passed ACMethod and calls ACMethod.IsValid(). Override this method if you wan't to implement some further validations. Alway call base.IsEnabledStart() first.

OnChangingCurrentACMethod(gip

Informs derivations that ReSendACMethod() was called.

OnSetCurrentACMethod(gip

Internal method, that is called when CurrentACMethod is changed. Don't use it!

OnSetMalfunction(gip

For internal usage only: Its invoked when Malfunction changes. Don't use it!

PersistCurrentACMethod

Persists the CurrentACMethod-Property

ReSendACMethod(gip

Sends the parameters of CurrentACMethod to an external system (e.g. PLC)

SetCurrentACProgram(gip

Only for internal usage! Use property CurrentACProgram.

Start(gip

Starts a new asynchronous process. IsEnabledStart() is called first to validate the parameters in the passed ACMethod-Object. If IsEnabledStart() fails, then ACMethodEventArgs ist returned with Global.ACMethodResultState.Failed or Global.ACMethodResultState.FailedAndRepeat. Else Global.ACMethodResultState.InProcess is returned and the invoking Workflow-Node is called back.