OPENSCSPoolManagerObjectType TOC Previous Next Specification

The representation of the OPENSCSPoolManagerObjectType ObjectType in the address space is shown in the following table:

Name Attribute
NodeId ns=1;i=15032
NamespaceUri http://opcfoundation.org/OPENSCS-SER/
BrowseName OPENSCSPoolManagerObjectType
NodeClass ObjectType
IsAbstract False
SubtypeOf BaseObjectType

The references from the OPENSCSPoolManagerObjectType ObjectType Node are shown in the following table:

Reference NodeClass BrowseName DataType TypeDefinition ModellingRule
HasProperty Variable MaxSNPushable UInt32 PropertyType Mandatory
HasProperty Variable MaxSNRequestable UInt32 PropertyType Mandatory
HasProperty Variable MaxSNReturnable UInt32 PropertyType Mandatory
HasProperty Variable PoolSelectionCriteria OPENSCSKeyValueDataType[] PropertyType Mandatory
HasProperty Variable SNFormat String[] PropertyType Mandatory
HasComponent Method SNRequestAllocated     Mandatory
HasComponent Method SNRequestUnallocated     Mandatory
HasComponent Method SNRequestUnassigned     Mandatory
HasComponent Method SNReturnAllocated     Mandatory
HasComponent Method SNReturnUnallocated     Mandatory
HasComponent Method SNtoAllocated     Mandatory
HasComponent Method SNtoEncoded     Mandatory
HasComponent Method SNtoUnallocated     Mandatory

SNRequestAllocated

Signature

    SNRequestAllocated(
        [in]  String SNCollectionID
        [in]  UInt32 Count
        [in]  String SNFormat
        [in]  OPENSCSKeyValueDataType PoolSelectionCriteria
        [in]  String RequestToken
        [out] OPENSCSReturnEnum ReturnStatus
        [out] OPENSCSSNCollectionDataType SNCollection
        [out] String ReturnedRequestToken
    );
Argument Description
SNCollectionID Identifies the Serial Number Collection from which unassigned Serial Numbers are to be provided.
Count Identifies the number of Serial Numbers requested.
SNFormat Defines the desired serial number format for the requested serial numbers.
PoolSelectionCriteria Identified value to be used by the method provider to determine which Serial Numbers to return.
RequestToken If it has a value of null or an empty string, then this is the initial request for Serial Numbers.
ReturnStatus Returns the status of the method execution.
SNCollection Contains requested Serial Number collection with Serial Numbers of the specified state.
ReturnedRequestToken If non null or an empty string, then there are more serial numbers to be returned and the returned Request Token is to be passed as an input parameter on a subsequent call.

SNRequestUnallocated

Signature

    SNRequestUnallocated(
        [in]  String SNCollectionID
        [in]  UInt32 Count
        [in]  String SNFormat
        [in]  OPENSCSKeyValueDataType PoolSelectionCriteria
        [in]  String RequestToken
        [out] OPENSCSReturnEnum ReturnStatus
        [out] OPENSCSSNCollectionDataType SNCollection
        [out] String ReturnedRequestToken
    );
Argument Description
SNCollectionID Identifies the Serial Number Collection from which unassigned Serial Numbers are to be provided.
Count Identifies the number of Serial Numbers requested.
SNFormat Defines the desired serial number format for the requested serial numbers.
PoolSelectionCriteria Identified value to be used by the method provider to determine which Serial Numbers to return.
RequestToken If it has a value of null or an empty string, then this is the initial request for Serial Numbers.
ReturnStatus Returns the status of the method execution.
SNCollection Contains requested Serial Number collection with Serial Numbers of the specified state.
ReturnedRequestToken If non null or an empty string, then there are more serial numbers to be returned and the returned Request Token is to be passed as an input parameter on a subsequent call.

SNRequestUnassigned

Signature

    SNRequestUnassigned(
        [in]  String SNCollectionID
        [in]  UInt32 Count
        [in]  String SNFormat
        [in]  OPENSCSKeyValueDataType PoolSelectionCriteria
        [in]  String RequestToken
        [out] OPENSCSReturnEnum ReturnStatus
        [out] OPENSCSSNCollectionDataType SNCollection
        [out] String ReturnedRequestToken
    );
Argument Description
SNCollectionID Identifies the Serial Number Collection from which unassigned Serial Numbers are to be provided.
Count Identifies the number of Serial Numbers requested.
SNFormat Defines the desired serial number format for the requested serial numbers.
PoolSelectionCriteria Identified value to be used by the method provider to determine which Serial Numbers to return.
RequestToken If it has a value of null or an empty string, then this is the initial request for Serial Numbers.
ReturnStatus Returns the status of the method execution.
SNCollection Contains requested Serial Number collection with Serial Numbers of the specified state.
ReturnedRequestToken If non null or an empty string, then there are more serial numbers to be returned and the returned Request Token is to be passed as an input parameter on a subsequent call.

SNReturnAllocated

Signature

    SNReturnAllocated(
        [in]  OPENSCSSNCollectionDataType SNCollection
        [in]  OPENSCSKeyValueDataType PoolSelectionCriteria
        [in]  String SNFormat
        [out] OPENSCSReturnEnum ReturnStatus
    );
Argument Description
SNCollection Contains a Serial Number Collection from which Serial Numbers were originally provided.
PoolSelectionCriteria Identified value to be used by the method provider to determine which pool to return the Serial Numbers to
SNFormat The serial number format of the serial numbers being returned.
ReturnStatus Returns the status of the method execution.

SNReturnUnallocated

Signature

    SNReturnUnallocated(
        [in]  OPENSCSSNCollectionDataType SNCollection
        [in]  OPENSCSKeyValueDataType PoolSelectionCriteria
        [in]  String SNFormat
        [out] OPENSCSReturnEnum ReturnStatus
    );
Argument Description
SNCollection Contains a Serial Number Collection from which Serial Numbers were originally provided.
PoolSelectionCriteria Identified value to be used by the method provider to determine which pool to return the Serial Numbers to
SNFormat The serial number format of the serial numbers being returned.
ReturnStatus Returns the status of the method execution.

SNtoAllocated

Signature

    SNtoAllocated(
        [in]  OPENSCSSNCollectionDataType SNCollection
        [in]  OPENSCSKeyValueDataType PoolSelectionCriteria
        [in]  String SNFormat
        [out] OPENSCSReturnEnum ReturnStatus
    );
Argument Description
SNCollection  
PoolSelectionCriteria  
SNFormat  
ReturnStatus  

SNtoEncoded

Signature

    SNtoEncoded(
        [in]  OPENSCSSNCollectionDataType SNCollection
        [in]  OPENSCSKeyValueDataType PoolSelectionCriteria
        [in]  String SNFormat
        [out] OPENSCSReturnEnum ReturnStatus
    );
Argument Description
SNCollection  
PoolSelectionCriteria  
SNFormat  
ReturnStatus  

SNtoUnallocated

Signature

    SNtoUnallocated(
        [in]  OPENSCSSNCollectionDataType SNCollection
        [in]  OPENSCSKeyValueDataType PoolSelectionCriteria
        [in]  String SNFormat
        [out] OPENSCSReturnEnum ReturnStatus
    );
Argument Description
SNCollection  
PoolSelectionCriteria  
SNFormat  
ReturnStatus