7.12.2 Stop Method

The signature of this Method is specified below.

Signature 

	Stop (
	[in]	0:Int64 	StopMode
	[out]	0:Int32	Status
	);

The Stop Method allows an authorized Client to command the system to stop executing and leave the Executing state.

In conjunction with the usage of this method, the transient states can be expressed with Substate machines within the Executing state (e.g. the ExecutingSubstateMachine in 7.14)

The input argument StopMode must be either 0 or one of those listed in the PossibleStopModes Variable (see Table 31). If not, then a Bad_InvalidArgument Result Code is returned.

Table 54 – Stop Method Arguments
Argument Description
StopModemust 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

<0 – shall be used for vendor-specific errors.

>0 – are reserved for errors defined by this and future standards

The possible Method result codes are formally defined in Table 55

Table 55 – Method Result Codes (defined in Call Service)
Result Code Description
GoodThe system level operation succeeded
Bad_InternalErrorThe system level operation failed because of an internal error
Bad_ResourceUnavailableThe Method is locked by another Client/Clientgroup
Bad_UserAccessDeniedThe caller is not allowed to call this Method.
Bad_InvalidArgumentThe input argument is invalid

The Stop Method representation in the AddressSpace is formally defined in Table 56

Table 56 – Stop Method AddressSpace definition.
Attribute Value
BrowseNameStop
References NodeClass BrowseName DataType TypeDefinition Others
0:HasPropertyVariable0:InputArguments0:Argument[]0:PropertyTypeM
0:HasPropertyVariable0:OutputArguments0:Argument[]0:PropertyTypeM
ConformanceUnits
Rob System Operation