SNReturnUnallocated – This method sends unallocated serial numbers back to an OPC UA Server that is performing serial number management of unassigned serial numbers for a specific Serial Number Pool.
The signature of this Method is specified below. Table 11 and Table 12 specify the Arguments and AddressSpace representation, respectively.
Signature
SNReturnUnallocated (
[in]OPENSCSSNCollectionDataTypeSNCollection
[in]OPENSCSKeyValueDataType[]PoolSelectionCriteria
[in]String SNFormat
[out]OPENSCSReturnEnum ReturnStatus
);
Table 11 – SNReturnUnallocated Method Arguments
Argument |
Description |
SNCollection |
Contains a Serial Number Collection from which Serial Numbers were originally provided. If the Serial Number Collection ID does not match a Serial Number Collection managed by the Information Provider, then an “Invalid Serial Number Collection” error is returned. |
PoolSelectionCriteria |
Identified value to be used by the method provider to determine which pool to return the Serial Numbers to. If no Pool Selection Criteria is defined, then the default Pool Selection Criteria of the method provider is used. If the pool selection criteria is not known to the server, then an “Invalid selection Criteria” error is returned. |
SNFormat |
The serial number format of the serial numbers being returned. If the Serial Number Format is not known to the method provider, then an “Invalid Serial Number Format” error is returned. |
ReturnStatus |
Returns the status of the method execution. |
Method Result Codes are defined as part of the Call service (see OPC 10000-4 and Table 95).
Table 12 – SNReturnUnallocated Method AddressSpace Definition
Attribute |
Value |
||||
BrowseName |
SNReturnUnallocated |
||||
IsAbstract |
True |
||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
0:HasProperty |
Variable |
InputArguments |
Argument[] |
0:PropertyType |
Mandatory |
0:HasProperty |
Variable |
OutputArguments |
Argument[] |
0:PropertyType |
Mandatory |