7.18.6 ConsumeAvailableValue Method
The ConsumeAvailableValue Method consumes part of the available money provided in the CurrentAvailableValue Variable.
If the execution of the Method cannot be done due to some application logic, the Method should return an Uncertain StatusCode and provide details of the failure in the Status output Argument. When the Method returns an Uncertain StatusCode, the Method is considered to be failed.
If the Method returns successful, it does indicate, that the CurrentAvailableValue Variable has been decreased.
The signature of this Method is specified below. Table 59 and Table 60 specify the Arguments and AddressSpace representation, respectively.
Signature
ConsumeAvailableValue (
[in] PriceDataType ValueToConsume,
[out] 0:Int32 Status);| Argument | Description |
| ValueToConsume | For each entry of the SupportedAssetList, the number of assets to be paid out. |
| Status | Status of the execution of the method. If issues occurred during execution. 0 = Execution was successful. -1 = Not enough value to consume available Vendors may return a vendor specific status starting with number -16 or smaller. |
Method Result Codes (defined in Call Service)
| Result Code | Description |
| Bad_UserAccessDenied | See OPC 10000-4 for a general description. |
| Attribute | Value | ||||
| BrowseName | ConsumeAvailableValue | ||||
| 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 |