7 OPC UA FX Interfaces
7.1 Overview
This clause defines all of the Interfaces defined in this document. These Interfaces will be used internally in this model and will be available for companion specifications. Figure 49 illustrates the Interfaces that are defined in this document. The definition of the components that are part of the Interface is provided in the Object Model that utilises the Interface. In this clause, only the definition of the Interface is provided.
7.2 IFunctionalEntityType Interface definition
The functional model is required to be able to be applied to existing Information Models. These models have defined their own Object Models and their own hierarchy of Objects. OPC UA does not support multiple inheritance. By defining the IFunctionalEntityType Interface, the OPC UA FX Information Model can be applied to any existing Object, adding the required IFunctionalEntityType items into the existing Information Model.
The IFunctionalEntityType Interface is formally defined in Table 104.
| Attribute | Value | ||||
| BrowseName | 3:IFunctionalEntityType | ||||
| IsAbstract | True | ||||
| References |
Node
Class | BrowseName | DataType | TypeDefinition | Other |
|---|---|---|---|---|---|
| Subtype of the 0:BaseInterfaceType defined in OPC 10000-5 | |||||
| 0:HasProperty | Variable | 3:AuthorUri | 0:UriString | 0:PropertyType | O |
| 0:HasProperty | Variable | 3:AuthorAssignedIdentifier | 0:String | 0:PropertyType | O |
| 0:HasProperty | Variable | 3:AuthorAssignedVersion | 3:FxVersion | 0:PropertyType | O |
| 0:HasProperty | Variable | 3:ApplicationIdentifier | 3:ApplicationIdentifierDataType[] | 0:PropertyType | O |
| 0:HasComponent | Method | 3:Verify | Defined in 6.4.3 | O | |
| 0:HasComponent | Object | 3:InputData | 3:InputsFolderType | O | |
| 0:HasComponent | Object | 3:OutputData | 3:OutputsFolderType | O | |
| 0:HasComponent | Object | 3:ConfigurationData | 3:ConfigurationDataFolderType | O | |
| 0:HasComponent | Object | 3:Capabilities | 3:FunctionalEntityCapabilitiesType | O | |
| 0:HasComponent | Object | 3:PublisherCapabilities | 3:PublisherCapabilitiesType | O | |
| 0:HasComponent | Object | 3:SubscriberCapabilities | 3:SubscriberCapabilitiesType | O | |
| 0:HasComponent | Object | 3:ConnectionEndpoints | 3:ConnectionEndpointsFolderType | O | |
| 0:HasComponent | Object | 3:ControlGroups | 3:ControlGroupsFolderType | O | |
| 0:HasComponent | Variable | 3:OperationalHealth | 3:OperationalHealthOptionSet | 0:BaseDataVariableType | O, RO |
| 0:HasComponent | Object | 3:OperationalHealthAlarms | 0:FolderType | O | |
| 0:HasComponent | Object | 5:Status | 5:FunctionalGroupType | O | |
| 0:HasComponent | Object | 5:Diagnostics | 5:FunctionalGroupType | O | |
| 0:HasComponent | Object | 5:Operational | 5:FunctionalGroupType | O | |
| ConformanceUnits | |||||
|---|---|---|---|---|---|
| UAFX FunctionalEntity Base |
The components of the IFunctionalEntityType have additional subcomponents, which are defined in Table 105
| BrowsePath | References | NodeClass | BrowseName | DataType | TypeDefinition | Others |
| 3:ConfigurationData | 0:Organizes | Object | 5:Configuration | 5:FunctionalGroupType | O | |
| 3:ConfigurationData | 0:Organizes | Object | 5:Tuning | 5:FunctionalGroupType | O | |
| 5:Diagnostics | 0:HasComponent | Variable | 3:OperationalConnectionCount | 0:UInt32 | 0:BaseDataVariableType | O |
| 5:Diagnostics | 0:HasComponent | Variable | 3:ExistingConnectionCount | 0:UInt32 | 0:BaseDataVariableType | O |
| 5:Diagnostics | 0:HasComponent | Variable | 3:ErrorConnectionCount | 0:UInt32 | 0:BaseDataVariableType | O |
| 5:Diagnostics | 0:HasComponent | Variable | 3:FailedConnectionCount | 0:UInt32 | 0:BaseDataVariableType | O |
| 5:Diagnostics | 0:HasComponent | Variable | 3:CleanedUpConnectionCount | 0:UInt32 | 0:BaseDataVariableType | O |
| 5:Diagnostics | 0:HasComponent | Variable | 3:TotalEstablishAttemptsCount | 0:UInt32 | 0:BaseDataVariableType | O |
| 5:Diagnostics | 0:HasComponent | Variable | 3:FailedEstablishAttemptsCount | 0:UInt32 | 0:BaseDataVariableType | O |
| 5:Diagnostics | 0:HasComponent | Variable | 3:FailedVerificationCount | 0:UInt32 | 0:BaseDataVariableType | O |
The definitions of all Properties, Variables and Objects that are used in this Interface are provided in 6.4.2. Examples of how this interface could be used are provided in Annex B.
7.3 IAssetRevisionType Interface definition
The IAssetRevisionType is an Interface that may be used in any existing asset model. This Interface defines version information that may be used by the VerifyAsset Method (also defined in the interface).
The IAssetRevisionType Interface is formally defined in Table 106.
| Attribute | Value | ||||
| BrowseName | 3:IAssetRevisionType | ||||
| IsAbstract | True | ||||
| References |
Node
Class | BrowseName | DataType | TypeDefinition | Other |
|---|---|---|---|---|---|
| Subtype of the 0:BaseInterfaceType defined in OPC 10000-5 | |||||
| 0:HasProperty | Variable | 3:MajorAssetVersion | 0:UInt16 | 0:PropertyType | O |
| 0:HasProperty | Variable | 3:MinorAssetVersion | 0:UInt16 | 0:PropertyType | O |
| 0:HasProperty | Variable | 3:BuildAssetNumber | 0:UInt16 | 0:PropertyType | O |
| 0:HasProperty | Variable | 3:SubBuildAssetNumber | 0:UInt16 | 0:PropertyType | O |
| 0:HasComponent | Method | 3:VerifyAsset | Defined in 6.3.3 | O | |
| ConformanceUnits | |||||
|---|---|---|---|---|---|
| UAFX Asset Base |
The definitions of all Properties that are used in this Interface are provided in 6.3.2.
7.4 IAssetExtensionsType Interface definition
The IAssetExtensionsType is an Interface that may be used in any existing asset model. This Interface defines a folder that can be used as a standard location for collecting Connector information.
The IAssetExtensionsType Interface is formally defined in Table 107.
| Attribute | Value | ||||
| BrowseName | 3:IAssetExtensionsType | ||||
| IsAbstract | True | ||||
| References |
Node
Class | BrowseName | DataType | TypeDefinition | Other |
|---|---|---|---|---|---|
| Subtype of the 0:BaseInterfaceType defined in OPC 10000-5 | |||||
| 0:HasComponent | Object | 3:Connectors | 0:FolderType | O | |
| 0:HasComponent | Object | 5:Diagnostics | 5:FunctionalGroupType | O | |
| ConformanceUnits | |||||
|---|---|---|---|---|---|
| UAFX Asset Base |
The components of the IAssetExtensionsType have additional subcomponents, which are defined in Table 108.
| BrowsePath | References | NodeClass | BrowseName | DataType | TypeDefinition | Others |
| 5:Diagnostics | 0:HasComponent | Variable | 3:UpTime | 0:Duration | 0:BaseDataVariableType | O |
| 5:Diagnostics | 0:HasComponent | Variable | 3:CurrentCPUUtilization | 0:Float | 0:BaseDataVariableType | O |
| 5:Diagnostics | 0:HasComponent | Variable | 3:MaxCPUUtilization | 0:Float | 0:BaseDataVariableType | O |
| 5:Diagnostics | 0:HasComponent | Variable | 3:CurrentMemoryUtilization | 0:Float | 0:BaseDataVariableType | O |
| 5:Diagnostics | 0:HasComponent | Variable | 3:MaxMemoryUtilization | 0:Float | 0:BaseDataVariableType | O |
The definitions of all items that are used in this Interface are provided in 6.3.2.