The UIInformationType provides graphical specifications required for creating faceplates to display the information made available by the OPC UA Server.
When the information described in the UIInformationType is provided, an OPC UA Client can render the visualisation without further configuration efforts. Thus a suitable zero-config, zero- engineering visualisation is possible.
The UIInformationType is formally defined in the following table.
Table 83 – UIInformationType Definition
|
Attribute |
Value |
||||
|
BrowseName |
UIInformationType |
||||
|
IsAbstract |
False |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node. |
|||||
|
0:HasComponent |
Method |
DeleteUIResource |
See below. |
M |
|
|
0:HasComponent |
Method |
LoadUIResource |
See below. |
M |
|
|
0:HasProperty |
Variable |
PositionX |
0:Double |
0:PropertyType |
M, RW |
|
0:HasProperty |
Variable |
PositionY |
0:Double |
0:PropertyType |
M, RW |
|
0:HasProperty |
Variable |
PositionZ |
0:Double |
0:PropertyType |
M, RW |
|
0:HasProperty |
Variable |
Resizable |
0:Boolean |
0:PropertyType |
M, RW |
|
0:HasComponent |
Object |
UIResources |
|
0:FolderType |
M |
|
0:HasProperty |
Variable |
Width |
0:Double |
0:PropertyType |
M, RW |
|
Conformance Units |
|||||
|
TMC Advanced Visualisation and Control |
|||||
The components of the UIInformationType are further described below.
|
BrowseName |
Description |
|
PositionX |
PositionX is the relative horizontal position of the top-left corner of the object rendering in the target visualization scope. |
|
PositionY |
PositionX is the relative vertical position of the top-left corner of the object rendering in the target visualization scope. |
|
PositionZ |
PositionZ is the depth of the object rendering in the target visualization scope. |
|
Resizable |
When Resizable is True, the UI resource Width is rescaled based on the actual display size. |
|
UIResources |
The UIResources folder contains any number of vectorial images of the object to be rendered in the status/mode defined by the name of the file, e.g. Running.svg is the representation of the object when the status is running. The server will persist external resources that a client will save into the folder. |
|
Width |
Width is the width of the object visualization in the target visualization scope. |
The components of the UIInformationType have additional subcomponents which are defined in the following table.
Table 84 – UIInformationType Additional Subcomponents
|
BrowsePath |
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Others |
|
UIResources |
0:HasProperty |
Variable |
<ResourceName> |
0:String |
0:PropertyType |
OP, RW |
|
UIResources |
0:HasProperty |
Variable |
Default |
0:String |
0:PropertyType |
M, RW |
The resource named ResourceName and Default strings describe Scalable Vector Graphics (SVG2) and, as such, comply with the W3C recommendations for SVG2 as published here: https://www.w3.org/TR/SVG2/.
The Method LoadUIResource loads a UI resource in the underlying system for visualization. It will override the existing UI resource by the same name.
The signature of this Method is specified below. Table 85 specifies the Arguments representation.
Signature
LoadUIResource (
[in] 0:String ResourceName,
[in] 0:String ResourceValue,
[out] MethodExecutionFeedbackType ExecutionFeedback);
Table 85 – LoadUIResource Method Arguments
|
Argument |
Description |
|
ResourceName |
The name of the UI resource to be created in the underlying system. |
|
ResourceValue |
The value that the UI resource will obtain in the underlying system, i.e. the SVG file. |
|
ExecutionFeedback |
The extended feedback returning a detailed message in case of execution failure. |
The Method DeleteUIResource permanently removes a UI resource from the underlying system memory.
The signature of this Method is specified below. Table 86 specifies the Arguments representation.
Signature
DeleteUIResource (
[in] 0:String ResourceName,
[out] MethodExecutionFeedbackType ExecutionFeedback);
Table 86 – DeleteUIResource Method Arguments
|
Argument |
Description |
|
ResourceName |
The name of the UI resource to be deleted from the underlying system. |
|
ExecutionFeedback |
The extended feedback returning a detailed message in case of execution failure. |