The signature of this Method is specified below.
Signature
Stop (
[in]0:Int64 StopMode
[out]0:Int32Status
);
Table 89 specifies the Arguments.
Table 89 – StopMethod Arguments
|
Argument |
Description |
|
StopMode |
must either be 0 or one of those listed in the PossibleStopModes Variable (see Table 31) |
|
Status |
0 – OK – Everything is OK 1 – E_SystemState – The system is not in correct state for this operation 2 – E_UnexpectedError – Unexpected Error during the method call 3 – E_ActiveAlarm – An Active Alarm prevents the system start 4 – E_AcknowledgeRequired – Condition needs to be acknowledged <0 – shall be used for vendor-specific errors. >0 – are reserved for errors defined by this and future standards |
The Stop Method allows an authorized Client to command the task control to stop executing and leave the Executing state and go to the Ready state. If the ReadySubstateMachine (see 7.17) is present, the task control shall be in the Suspended state of the Substate machine.
The input argument StopMode must be either 0 or one of those listed in the PossibleStopModes Variable (see Section). If not, then a Bad_InvalidArgument Result Code is returned.
The possible Method result codes are formally defined in the table below.
Table 90 – Method Result Codes (defined in Call Service)
|
Result Code |
Description |
|
Good |
The task control operation succeeded |
|
Bad_InternalError |
The task control operation failed because of an internal error |
|
Bad_ResourceUnavailable |
The Method is locked by another Client/Clientgroup |
|
Bad_UserAccessDenied |
The caller is not allowed to call this Method. |
The Stop Method representation in the AddressSpace is formally defined in Table 91.
Table 91 – Stop Method AddressSpace definition.
|
Attribute |
Value |
||||
|
BrowseName |
Stop |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
|
0:HasProperty |
Variable |
0:OutputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
|
ConformanceUnits |
|||||
|
Rob Task Control Operation |
|||||