12 Standard DataTypes

12.1 General

Standard DataTypes are described in the following subclauses.

12.2 DataTypes defined in OPC 10000-3

OPC 10000-3 defines a set of DataTypes. Their representations in the AddressSpace are defined in the following subclauses.

12.2.1 BaseDataType

The representation in the AddressSpace of the BaseDataType DataType is defined in Table 154.

Table 154 – BaseDataType definition
Attributes Value
BrowseNameBaseDataType
IsAbstractTRUE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Conformance Units
Base Info Base Types

12.2.2 Boolean

The representation in the AddressSpace of the Boolean DataType is specified in Table 155.

Table 155 – Boolean definition
Attributes Value
BrowseNameBoolean
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the BaseDataType DataType defined in Table 154.
Conformance Units
Base Info Base Types

12.2.3 ByteString

The representation in the AddressSpace of the ByteString DataType is defined in Table 156.

Table 156 – ByteString definition
Attributes Value
BrowseNameByteString
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the BaseDataType DataType defined in Table 154.
Conformance Units
Base Info Base Types
12.2.3.1 AudioDataType

The representation in the AddressSpace of the AudioDataType DataType is defined in Table 157.

Table 157 – AudioDataType definition
Attributes Value
BrowseNameAudioDataType
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the ByteString DataType defined in Table 156.
Conformance Units
Base Info Audio Type
12.2.3.2 Image

The representation in the AddressSpace of the Image DataType is defined in Table 158.

Table 158 – Image definition
Attributes Value
BrowseNameImage
IsAbstractTRUE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the ByteString DataType defined in Table 156.
Conformance Units
Base Info Image DataTypes
12.2.3.3 ImageBMP

The representation in the AddressSpace of the ImageBMP DataType is defined in Table 159.

Table 159 – ImageBMP definition
Attributes Value
BrowseNameImageBMP
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Image DataType defined in Table 158.
Conformance Units
Base Info Image DataTypes
12.2.3.4 ImageGIF

The representation in the AddressSpace of the ImageGIF DataType is defined in Table 160.

Table 160 – ImageGIF definition
Attributes Value
BrowseNameImageGIF
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Image DataType defined in Table 158.
Conformance Units
Base Info Image DataTypes
12.2.3.5 ImageJPG

The representation in the AddressSpace of the ImageJPG DataType is defined in Table 161.

Table 161 – ImageJPG definition
Attributes Value
BrowseNameImageJPG
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Image DataType defined in Table 158.
Conformance Units
Base Info Image DataTypes
12.2.3.6 ImagePNG

The representation in the AddressSpace of the ImagePNG DataType is defined in Table 162.

Table 162 – ImagePNG definition
Attributes Value
BrowseNameImagePNG
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Image DataType defined in Table 158.
Conformance Units
Base Info Image DataTypes

12.2.4 DateTime

The representation in the AddressSpace of the DateTime DataType is defined in Table 163.

Table 163 – DateTime definition
Attributes Value
BrowseNameDateTime
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the BaseDataType DataType defined in Table 154.
Conformance Units
Base Info Base Types
12.2.4.1 UtcTime

The representation in the AddressSpace of the UtcTime DataType is defined in Table 164.

Table 164 – UtcTime definition
Attributes Value
BrowseNameUtcTime
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the DateTime DataType defined in Table 163.
Conformance Units
Base Info Base Types

12.2.5 Enumeration

The representation in the AddressSpace of the Enumeration DataType is defined in Table 165.

Table 165 – Enumeration definition
Attributes Value
BrowseNameEnumeration
IsAbstractTRUE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the BaseDataType DataType defined in Table 154.
Conformance Units
Base Info Base Types
12.2.5.1 IdType

The representation in the AddressSpace of the IdType DataType is defined in Table 166.

Table 166 – IdType definition
Attributes Value
BrowseNameIdType
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Enumeration DataType defined in Table 165.
HasPropertyVariableEnumStringsLocalizedText[]PropertyType
Conformance Units
Base Info Base Types
12.2.5.2 NodeClass

The representation in the AddressSpace of the NodeClass DataType is defined in Table 167.

Table 167 – NodeClass definition
Attributes Value
BrowseNameNodeClass
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Enumeration DataType defined in Table 165.
HasPropertyVariableEnumValuesEnumValueType []PropertyType
Conformance Units
Base Info Base Types
12.2.5.3 StructureType

The representation in the AddressSpace of the StructureType DataType is defined in Table 168.

Table 168 – StructureType definition
Attributes Value
BrowseNameStructureType
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Enumeration DataType defined in Table 165.
HasPropertyVariableEnumStringsLocalizedText[]PropertyType
Conformance Units
Address Space DataTypeDefinition Attribute

12.2.6 Guid

The representation in the AddressSpace of the Guid DataType is specified in Table 169.

Table 169 – Guid definition
Attributes Value
BrowseNameGuid
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the BaseDataType DataType defined in Table 154.
Conformance Units
Base Info Base Types

12.2.7 LocalizedText

The representation in the AddressSpace of the LocalizedText DataType is specified in Table 170.

Table 170 – LocalizedText definition
Attributes Value
BrowseNameLocalizedText
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the BaseDataType DataType defined in Table 154.
Conformance Units
Base Info Base Types

12.2.8 NodeId

The representation in the AddressSpace of the NodeId DataType is specified in Table 171.

Table 171 – NodeId definition
Attributes Value
BrowseNameNodeId
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the BaseDataType DataType defined in Table 154.
Conformance Units
Base Info Base Types

12.2.9 Number

The representation in the AddressSpace of the Number DataType is defined in Table 172.

Table 172 – Number definition
Attributes Value
BrowseNameNumber
IsAbstractTRUE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the BaseDataType DataType defined in Table 154.
Conformance Units
Base Info Base Types
12.2.9.1 Decimal

The representation in the AddressSpace of the Decimal DataType is defined in Table 173.

Table 173 – Decimal definition
Attributes Value
BrowseNameDecimal
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Number DataType defined in Table 172.
Conformance Units
Base Info Decimal DataType
12.2.9.2 Double

The representation in the AddressSpace of the Double DataType is defined in Table 174.

Table 174 – Double definition
Attributes Value
BrowseNameDouble
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Number DataType defined in Table 172.
Conformance Units
Base Info Base Types
12.2.9.3 Duration

The representation in the AddressSpace of the Duration DataType is defined inTable 175.

Table 175 – Duration definition
Attributes Value
BrowseNameDuration
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Double DataType defined in Table 174.
Conformance Units
Base Info Base Types
12.2.9.4 Float

The representation in the AddressSpace of the Float DataType is defined in Table 176.

Table 176 – Float definition
Attributes Value
BrowseNameFloat
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Number DataType defined in Table 172.
Conformance Units
Base Info Base Types
12.2.9.5 Integer

The representation in the AddressSpace of the Integer DataType is defined in Table 177.

Table 177 – Integer definition
Attributes Value
BrowseNameInteger
IsAbstractTRUE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Number DataType defined in Table 172.
Conformance Units
Base Info Base Types
12.2.9.6 Int16

The representation in the AddressSpace of the Int16 DataType is defined in Table 178.

Table 178 – Int16 definition
Attributes Value
BrowseNameInt16
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Integer DataType defined in Table 177.
Conformance Units
Base Info Base Types
12.2.9.7 Int32

The representation in the AddressSpace of the Int32 DataType is defined in Table 179.

Table 179 – Int32 definition
Attributes Value
BrowseNameInt32
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Integer DataType defined in Table 177.
Conformance Units
Base Info Base Types
12.2.9.8 Int64

The representation in the AddressSpace of the Int64 DataType is defined in Table 180.

Table 180 – Int64 definition
Attributes Value
BrowseNameInt64
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Integer DataType defined in Table 177.
Conformance Units
Base Info Base Types
12.2.9.9 SByte

The representation in the AddressSpace of the SByte DataType is defined in Table 181.

Table 181 – SByte definition
Attributes Value
BrowseNameSByte
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Integer DataType defined in Table 177.
Conformance Units
Base Info Base Types
12.2.9.10 UInteger

The representation in the AddressSpace of the UInteger are defined in Table 182.

Table 182 – UInteger definition
Attributes Value
BrowseNameUInteger
IsAbstractTRUE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Number DataType defined in Table 172.
Conformance Units
Base Info Base Types
12.2.9.11 Byte

The representation in the AddressSpace of the Byte DataType is defined in Table 183.

Table 183 – Byte definition
Attributes Value
BrowseNameByte
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the UInteger DataType defined in Table 182.
Conformance Units
Base Info Base Types
12.2.9.12 UInt16

The representation in the AddressSpace of the UInt16 DataType is defined in Table 184.

Table 184 – UInt16 definition
Attributes Value
BrowseNameUInt16
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the UInteger DataType defined in Table 182.
Conformance Units
Base Info Base Types
12.2.9.13 AccessRestrictionType

The representation in the AddressSpace of the AccessRestrictionType DataType is defined in Table 185.

Table 185 – AccessRestrictionType definition
Attributes Value
BrowseNameAccessRestrictionType
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
HasPropertyVariableOptionSetValuesLocalizedText[]PropertyType
Subtype of the UInt16 DataType defined in Table 184.
Conformance Units
Security Role Server Base 2
12.2.9.14 UInt32

The representation in the AddressSpace of the UInt32 DataType is defined in Table 186.

Table 186 – UInt32 definition
Attributes Value
BrowseNameUInt32
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the UInteger DataType defined in Table 182.
Conformance Units
Base Info Base Types
12.2.9.15 UInt64

The representation in the AddressSpace of the UInt64 DataType is defined in Table 187.

Table 187 – UInt64 definition
Attributes Value
BrowseNameUInt64
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the UInteger DataType defined in Table 182.
Conformance Units
Base Info Base Types

12.2.10 QualifiedName

The representation in the AddressSpace of the QualifiedName DataType is specified in Table 188.

Table 188 – QualifiedName definition
Attributes Value
BrowseNameQualifiedName
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the BaseDataType DataType defined in Table 154.
Conformance Units
Base Info Base Types

12.2.11 String

The representation in the AddressSpace of the String DataType is defined in Table 189.

Table 189 – String definition
Attributes Value
BrowseNameString
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the BaseDataType DataType defined in Table 154.
Conformance Units
Base Info Base Types
12.2.11.1 LocaleId

The representation in the AddressSpace of the LocaleId DataType is defined in Table 190.

Table 190 – LocaleId definition
Attributes Value
BrowseNameLocaleId
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the String DataType defined in Table 189.
Conformance Units
Base Info ServerType
12.2.11.2 NormalizedString

The representation in the AddressSpace of the NormalizedString DataType is defined in Table 191.

Table 191 – NormalizedString definition
Attributes Value
BrowseNameNormalizedString
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the String DataType defined in Table 189.
Conformance Units
Base Info NormalizedString DataType
12.2.11.3 DecimalString

The representation in the AddressSpace of the DecimalString DataType is defined in Table 192.

Table 192 – DecimalString definition
Attributes Value
BrowseNameDecimalString
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the String DataType defined in Table 189.
Conformance Units
Base Info DecimalString DataType
12.2.11.4 DurationString

The representation in the AddressSpace of the DurationString DataType is defined in Table 193.

Table 193 – DurationString definition
Attributes Value
BrowseNameDurationString
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the String DataType defined in Table 189.
Conformance Units
Base Info Date DataTypes
12.2.11.5 TimeString

The representation in the AddressSpace of the TimeString DataType is defined in Table 194.

Table 194 – TimeString definition
Attributes Value
BrowseNameTimeString
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the String DataType defined in Table 189.
Conformance Units
Base Info Date DataTypes
12.2.11.6 DateString

The representation in the AddressSpace of the DateString DataType is defined in Table 195.

Table 195 – DateString definition
Attributes Value
BrowseNameDateString
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the String DataType defined in Table 189.
Conformance Units
Base Info Date DataTypes

12.2.12 Structure

The representation in the AddressSpace of the Structure DataType is defined in Table 196.

Table 196 – Structure definition
Attributes Value
BrowseNameStructure
IsAbstractTRUE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the BaseDataType DataType defined in Table 154.
Conformance Units
Base Info Base Types
12.2.12.1 Argument

The representation in the AddressSpace of the Argument DataType is defined in Table 197.

Table 197 – Argument definition
Attributes Value
BrowseNameArgument
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info Method Argument DataType
12.2.12.2 CurrencyUnitType

The representation in the AddressSpace of the CurrencyUnitType DataType is defined in Table 198.

Table 198 – CurrencyUnitType definition
Attributes Value
BrowseNameCurrencyUnitType
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info Currency
12.2.12.3 DataTypeDefinition

The representation in the AddressSpace of the DataTypeDefinition DataType is defined in Table 199.

Table 199 – DataTypeDefinition definition
Attributes Value
BrowseNameDataTypeDefinition
IsAbstractTRUE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Address Space DataTypeDefinition Attribute
12.2.12.4 EnumDefinition

The representation in the AddressSpace of the EnumDefinition DataType is defined in Table 200.

Table 200 – EnumDefinition definition
Attributes Value
BrowseNameEnumDefinition
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the DataTypeDefinition defined in Table 199.
Conformance Units
Address Space DataTypeDefinition Attribute
12.2.12.5 StructureDefinition

The representation in the AddressSpace of the StructureDefinition DataType is defined in Table 201.

Table 201 – StructureDefinition definition
Attributes Value
BrowseNameStructureDefinition
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the DataTypeDefinition defined in Table 199.
Conformance Units
Address Space DataTypeDefinition Attribute
12.2.12.6 EnumValueType

The representation in the AddressSpace of the EnumValueType DataType is defined in Table 202.

Table 202 – EnumValueType definition
Attributes Value
BrowseNameEnumValueType
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info Base Types
12.2.12.7 EnumField

The representation in the AddressSpace of the EnumField DataType is defined in Table 203.

Table 203 – EnumField definition
Attributes Value
BrowseNameEnumField
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the EnumValueType defined in Table 202.
Conformance Units
Address Space DataTypeDefinition Attribute
12.2.12.8 OptionSet

The representation in the AddressSpace of the OptionSet DataType is defined in Table 204.

Table 204 – OptionSet definition
Attributes Value
BrowseNameOptionSet
IsAbstractTRUE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info OptionSet DataType
12.2.12.9 RolePermissionType

The representation in the AddressSpace of the RolePermissionType DataType is defined in Table 205.

Table 205 – RolePermissionType definition
Attributes Value
BrowseNameRolePermissionType
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Security Role Server Base 2
12.2.12.10 StructureField

The representation in the AddressSpace of the StructureField DataType is defined in Table 206.

Table 206 – StructureField definition
Attributes Value
BrowseNameStructureField
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Address Space DataTypeDefinition Attribute
12.2.12.11 TimeZoneDataType

The representation in the AddressSpace of the TimeZoneDataType DataType is defined in Table 207.

Table 207 – TimeZoneDataType definition
Attributes Value
BrowseNameTimeZoneDataType
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info LocalTime
12.2.12.12 Union

The representation in the AddressSpace of the Union DataType is defined in Table 208.

Table 208 – Union definition
Attributes Value
BrowseNameUnion
IsAbstractTRUE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info OptionSet DataType

12.2.13 XmlElement

The representation in the AddressSpace of the XmlElement DataType is specified in Table 209.

Table 209 – XmlElement definition
Attributes Value
BrowseNameXmlElement
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the BaseDataType DataType defined in Table 154.
Conformance Units
Base Info Base Types

12.3 DataTypes defined in OPC 10000-4

OPC 10000-4 defines a set of DataTypes. Their representations in the AddressSpace are defined in the following subclauses.

12.3.1 AddNodesItem

The representation in the AddressSpace of the AddNodesItem DataType is defined in Table 210.

Table 210 – AddNodesItem definition
Attributes Value
BrowseNameAddNodesItem
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Auditing NodeManagement

12.3.2 AddReferencesItem

The representation in the AddressSpace of the AddReferencesItem DataType is defined in Table 211.

Table 211 – AddReferencesItem definition
Attributes Value
BrowseNameAddReferencesItem
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Auditing NodeManagement

12.3.3 ApplicationDescription

The representation in the AddressSpace of the ApplicationDescription DataType is defined in Table 212.

Table 212 – ApplicationDescription definition
Attributes Value
BrowseNameApplicationDescription
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info ServerType

12.3.4 ContentFilter

The representation in the AddressSpace of the ContentFilter DataType is defined in Table 213.

Table 213 – ContentFilter definition
Attributes Value
BrowseNameContentFilter
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info ContentFilter

12.3.5 DataValue

The representation in the AddressSpace of the DateValue DataType is defined in Table 214.

Table 214 – DataValue definition
Attributes Value
BrowseNameDataValue
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the BaseDataType DataType defined in Table 154.
Conformance Units
Base Info Base Types

12.3.6 DeleteNodesItem

The representation in the AddressSpace of the DeleteNodesItem DataType is defined in.Table 215.

Table 215 – DeleteNodesItem definition
Attributes Value
BrowseNameDeleteNodesItem
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Auditing NodeManagement

12.3.7 DeleteReferencesItem

The representation in the AddressSpace of the DeleteReferencesItem DataType is defined in Table 216.

Table 216 – DeleteReferencesItem definition
Attributes Value
BrowseNameDeleteReferencesItem
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Auditing NodeManagement

12.3.8 DiagnosticInfo

The representation in the AddressSpace of the DiagnosticInfo DataType is defined in Table 217.

Table 217 – DiagnosticInfo definition
Attributes Value
BrowseNameDiagnosticInfo
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the BaseDataType DataType defined in Table 196.
Conformance Units
Base Info Base Types

12.3.9 ExpandedNodeId

The representation in the AddressSpace of the ExpandedNodeId DataType is defined in Table 218.

Table 218 – ExpandedNodeId definition
Attributes Value
BrowseNameExpandedNodeId
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the BaseDataType DataType defined in Table 196.
Conformance Units
Base Info Base Types

12.3.10 MessageSecurityMode

The representation in the AddressSpace of the MessageSecurityMode DataType is defined in Table 219.

Table 219 – MessageSecurityMode definition
Attributes Value
BrowseNameMessageSecurityMode
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Enumeration DataType defined in Table 165.
HasPropertyVariableEnumStringsLocalizedText[]PropertyType
Conformance Units
Base Info ServerType

12.3.11 NumericRange

The representation in the AddressSpace of the NumericRange DataType is defined in Table 220.

Table 220 – NumericRange definition
Attributes Value
BrowseNameNumericRange
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the String DataType defined in Table 189.
Conformance Units
Base Info Base Types

12.3.12 SecurityTokenRequestType

The representation in the AddressSpace of the SecurityTokenRequestType DataType is defined in Table 221.

Table 221 – SecurityTokenRequestType definition
Attributes Value
BrowseNameSecurityTokenRequestType
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Enumeration DataType defined in Table 165.
HasPropertyVariableEnumStringsLocalizedText[]PropertyType
Conformance Units
Auditing Connections

12.3.13 SignedSoftwareCertificate

The representation in the AddressSpace of the SignedSoftwareCertificate DataType is defined in Table 222.

Table 222 – SignedSoftwareCertificate definition
Attributes Value
BrowseNameSignedSoftwareCertificate
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Auditing Connections

12.3.14 StatusCode

The representation in the AddressSpace of the StatusCode DataType is defined in Table 223.

Table 223 – StatusCode definition
Attributes Value
BrowseNameStatusCode
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the BaseDataType DataType defined in Table 186.
Conformance Units
Base Info Base Types

12.3.15 UserIdentityToken

The representation in the AddressSpace of the UserIdentityToken DataType is defined in Table 224.

Table 224 – UserIdentityToken definition
Attributes Value
BrowseNameUserIdentityToken
IsAbstractTRUE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Auditing Connections
12.3.15.1 AnonymousIdentityToken

The representation in the AddressSpace of the AnonymousIdentityToken DataType is defined in Table 225.

Table 225 – AnonymousIdentityToken definition
Attributes Value
BrowseNameAnonymousIdentityToken
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the UserIdentityToken DataType defined in Table 224.
Conformance Units
Auditing Connections
12.3.15.2 IssuedIdentityToken

The representation in the AddressSpace of the IssuedIdentityToken DataType is defined in Table 226.

Table 226 – IssuedIdentityToken definition
Attributes Value
BrowseNameIssuedIdentityToken
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the UserIdentityToken DataType defined in Table 224.
Conformance Units
Auditing Connections
12.3.15.3 UserNameIdentityToken

The representation in the AddressSpace of the UserNameIdentityToken DataType is defined in Table 227.

Table 227 – UserNameIdentityToken definition
Attributes Value
BrowseNameUserNameIdentityToken
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the UserIdentityToken DataType defined in Table 224.
Conformance Units
Auditing Connections
12.3.15.4 X509IdentityToken

The representation in the AddressSpace of the X509IdentityToken DataType is defined in Table 228.

Table 228 – X509IdentityToken definition
Attributes Value
BrowseNameX509IdentityToken
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the UserIdentityToken DataType defined in Table 224.
Conformance Units
Auditing Connections

12.3.16 VersionTime

The representation in the AddressSpace of the VersionTime DataType is defined in Table 229.

Table 229 – VersionTime definition
Attributes Value
BrowseNameVersionTime
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the UInt32 DataType defined in Table 186.
Conformance Units
Base Info ServerType

12.4 BuildInfo

This structure contains elements that describe the build information of the Server. Its elements are defined in Table 230.

Table 230 – BuildInfo Structure
NameTypeDescription
BuildInfostructureInformation that describes the build of the software.

productUri

StringURI that identifies the software

manufacturerName

StringName of the software manufacturer.

productName

StringName of the software.

softwareVersion

StringSoftware version

buildNumber

StringBuild number

buildDate

UtcTimeDate and time of the build.

Its representation in the AddressSpace is defined in Table 231.

Table 231 – BuildInfo definition
Attributes Value
BrowseNameBuildInfo
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info ServerType

12.5 RedundancySupport

This DataType is an enumeration that defines the redundancy support of the Server. Its values are defined in Table 232.

Table 232 – RedundancySupport values
NameValueDescription
NONE0None means that there is no redundancy support.
COLD1Cold means that the server supports cold redundancy as defined in OPC 10000-4.
WARM2Warm means that the server supports warm redundancy as defined in OPC 10000-4.
HOT3Hot means that the server supports hot redundancy as defined in OPC 10000-4.
TRANSPARENT4Transparent means that the server supports transparent redundancy as defined in OPC 10000-4.
HOT_AND_MIRRORED5HotAndMirrored means that the server supports HotAndMirrored redundancy as defined in OPC 10000-4.

See OPC 10000-4 for a more detailed description of the different values.

Its representation in the AddressSpace is defined in Table 233.

Table 233 – RedundancySupport definition
Attributes Value
BrowseNameRedundancySupport
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Enumeration DataType defined in Table 165.
HasPropertyVariableEnumStringsLocalizedText[]PropertyType
Conformance Units
Base Info ServerType

12.6 ServerState

This DataType is an enumeration that defines the execution state of the Server. Its values are defined in Table 234.

Table 234 – ServerState values
NameValueDescription
RUNNING0The Server is running normally. This is the usual state for a Server.
FAILED1A vendor-specific fatal error has occurred within the Server. The Server is no longer functioning. The recovery procedure from this situation is vendor-specific. Most Service requests should be expected to fail.
NO_CONFIGURATION2The Server is running but has no configuration information loaded and therefore does not transfer data.
SUSPENDED3The Server has been temporarily suspended by some vendor-specific method and is not receiving or sending data.
SHUTDOWN4The Server initiated a shut down or is in the process of shutting down. This ServerState is intended as an indication to Clients connected to the Server to orderly disconnect from the Server before the Server completes the shut down.
TEST5The Server is in Test Mode. The outputs are disconnected from the real hardware, but the Server will otherwise behave normally. Inputs may be real or may be simulated depending on the vendor implementation. StatusCode will generally be returned normally.
COMMUNICATION_FAULT6The Server is running properly, but is having difficulty accessing data from its data sources. This may be due to communication problems or some other problem preventing the underlying device, control system, etc. from returning valid data. It may be a complete failure, meaning that no data is available, or a partial failure, meaning that some data is still available. It is expected that items affected by the fault will individually return with a BAD FAILURE status code indication for the items.
UNKNOWN7This state is used only to indicate that the OPC UA Server does not know the state of underlying system.

Its representation in the AddressSpace is defined in Table 235.

Table 235 – ServerState definition
Attributes Value
BrowseNameServerState
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Enumeration DataType defined in Table 165.
HasPropertyVariableEnumStringsLocalizedText[]PropertyType
Conformance Units
Base Info ServerType

12.7 RedundantServerDataType

This structure contains elements that describe the status of the Server. Its composition is defined in Table 236.

Table 236 – RedundantServerDataType Structure
NameTypeDescription
RedundantServerDataTypestructure

serverId

StringIdentifies the Server uniquely.

serviceLevel

ByteThe service level of the server.

serverState

ServerStateThe current state of the server.

Its representation in the AddressSpace is defined in Table 237.

Table 237 – RedundantServerDataType definition
Attributes Value
BrowseNameRedundantServerDataType
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Redundancy Server Transparent

12.8 SamplingIntervalDiagnosticsDataType

This structure contains diagnostic information about the sampling rates currently used by the Server. Its elements are defined in Table 238.

Table 238 – SamplingIntervalDiagnosticsDataType Structure
NameTypeDescription
SamplingIntervalDiagnosticsDataTypestructure

samplingInterval

DurationThe sampling interval in milliseconds.

monitoredItemCount

UInt32The number of MonitoredItems being sampled at this sample rate.

maxMonitoredItemCount

UInt32The maximum number of MonitoredItems being sampled at this sample rate at the same time since the server was started (restarted).

disabledMonitoredItemCount

UInt32The number of MonitoredItems at this sample rate whose sampling is currently disabled.

Its representation in the AddressSpace is defined in Table 239.

Table 239 – SamplingIntervalDiagnosticsDataType definition
Attributes Value
BrowseNameSamplingIntervalDiagnosticsDataType
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info ServerType

12.9 ServerDiagnosticsSummaryDataType

This structure contains diagnostic summary information for the Server. Its elements are defined in Table 240.

Table 240 – ServerDiagnosticsSummaryDataType Structure
NameTypeDescription
ServerDiagnosticsSummaryDataTypestructure

serverViewCount

UInt32The number of server-created views in the server.

currentSessionCount

UInt32The number of client sessions currently established in the server.

cumulatedSessionCount

UInt32The cumulative number of client sessions that have been established in the server since the server was started (or restarted). This includes the currentSessionCount.

securityRejectedSessionCount

UInt32The number of client session establishment requests (ActivateSession and CreateSession) that were rejected due to security constraints since the server was started (or restarted).

rejectedSessionCount

UInt32The number of client session establishment requests (ActivateSession and CreateSession) that were rejected since the server was started (or restarted). This number includes the securityRejectedSessionCount.

sessionTimeoutCount

UInt32The number of client sessions that were closed due to timeout since the server was started (or restarted).

sessionAbortCount

UInt32The number of client sessions that were closed due to errors since the server was started (or restarted).

currentSubscriptionCount

UInt32The number of subscriptions currently established in the server.

cumulatedSubscriptionCount

UInt32The cumulative number of subscriptions that have been established in the server since the server was started (or restarted). This includes the currentSubscriptionCount.

publishingIntervalCount

UInt32The number of publishing intervals currently supported in the server.

securityRejectedRequestsCount

UInt32The number of requests that were rejected due to security constraints since the server was started (or restarted). The requests include all Services defined in OPC 10000-4, also requests to create sessions.

rejectedRequestsCount

UInt32The number of requests that were rejected since the server was started (or restarted). The requests include all Services defined in OPC 10000-4, also requests to create sessions. This number includes the securityRejectedRequestsCount.

Its representation in the AddressSpace is defined in Table 241.

Table 241 – ServerDiagnosticsSummaryDataType definition
Attributes Value
BrowseNameServerDiagnosticsSummaryDataType
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info ServerType

12.10 ServerStatusDataType

This structure contains elements that describe the status of the Server. Its composition is defined in Table 242.

Table 242 – ServerStatusDataType Structure
NameTypeDescription
ServerStatusDataTypestructure

startTime

UtcTimeTime (UTC) the Server was started. This is constant for the Server instance and is not reset when the Server changes state. Each instance of a Server should keep the time when the process started.

currentTime

UtcTimeThe current time (UTC) as known by the Server.

state

ServerStateThe current state of the Server. Its values are defined in 12.6.

buildInfo

BuildInfo

secondsTillShutdown

UInt32

Approximate number of seconds until the Server will be shut down. The value is only relevant once the state changes into SHUTDOWN_4.

After the Server shut down is initated, the state changes to SHUTDOWN_4 and the actual shut down should be delayed for a configurable time if Clients are connected to the Server to allow these Clients an orderly disconnect.

shutdownReason

LocalizedTextA localized text indicating the reason for the shutdown. The value is only relevant once the state changes into SHUTDOWN_4. If there is no specific reason for the shutdown, then this value may be set to null or it may be empty.

Its representation in the AddressSpace is defined in Table 243.

Table 243 – ServerStatusDataType definition
Attributes Value
BrowseNameServerStatusDataType
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info ServerType

12.11 SessionDiagnosticsDataType

This structure contains diagnostic information about client sessions. Its elements are defined in Table 244. Most of the values represented in this structure provide information about the number of calls of a Service, the number of currently used MonitoredItems, etc. Those numbers need not provide the exact value; they need only provide the approximate number, so that the Server is not burdened with providing the exact numbers.

Table 244 – SessionDiagnosticsDataType Structure
NameTypeDescription
SessionDiagnosticsDataTypestructure

sessionId

NodeIdServer-assigned identifier of the session.

sessionName

StringThe name of the session provided in the CreateSession request.

clientDescription

Application

Description

The description provided by the client in the CreateSession request.

serverUri

StringThe serverUri request in the CreateSession request.

endpointUrl

StringThe endpointUrl passed by the client to the CreateSession request.

localeIds

LocaleId[]Array of LocaleIds specified by the client in the open session call.

actualSessionTimeout

DurationThe requested session timeout specified by the client in the open session call.

maxResponseMessageSize

UInt32The maximum size for the response message sent to the client.

clientConnectionTime

UtcTimeThe server timestamp when the client opens the session.

clientLastContactTime

UtcTimeThe server timestamp of the last request of the client in the context of the session.

currentSubscriptionsCount

UInt32The number of subscriptions currently used by the session.

currentMonitoredItemsCount

UInt32The number of MonitoredItems currently used by the session

currentPublishRequestsInQueue

UInt32The number of publish requests currently in the queue for the session.

totalRequestCount

ServiceCounter
DataType
Counter of all Services, identifying the number of received requests of any Services on the session.

unauthorizedRequestCount

UInt32Counter of all Services, identifying the number of Service requests that were rejected due to authorization failure

readCount

ServiceCounter
DataType
Counter of the Read Service, identifying the number of received requests of this Service on the session.

historyReadCount

ServiceCounter
DataType
Counter of the HistoryRead Service, identifying the number of received requests of this Service on the session.

writeCount

ServiceCounter
DataType
Counter of the Write Service, identifying the number of received requests of this Service on the session.

historyUpdateCount

ServiceCounter
DataType
Counter of the HistoryUpdate Service, identifying the number of received requests of this Service on the session.

callCount

ServiceCounter
DataType
Counter of the Call Service, identifying the number of received requests of this Service on the session.

createMonitoredItemsCount

ServiceCounter
DataType
Counter of the CreateMonitoredItems Service, identifying the number of received requests of this Service on the session.

modifyMonitoredItemsCount

ServiceCounter
DataType
Counter of the ModifyMonitoredItems Service, identifying the number of received requests of this Service on the session.

setMonitoringModeCount

ServiceCounter
DataType
Counter of the SetMonitoringMode Service, identifying the number of received requests of this Service on the session.

setTriggeringCount

ServiceCounter
DataType
Counter of the SetTriggering Service, identifying the number of received requests of this Service on the session.

deleteMonitoredItemsCount

ServiceCounter
DataType
Counter of the DeleteMonitoredItems Service, identifying the number of received requests of this Service on the session.

createSubscriptionCount

ServiceCounter
DataType
Counter of the CreateSubscription Service, identifying the number of received requests of this Service on the session.

modifySubscriptionCount

ServiceCounter
DataType
Counter of the ModifySubscription Service, identifying the number of received requests of this Service on the session.

setPublishingModeCount

ServiceCounter
DataType
Counter of the SetPublishingMode Service, identifying the number of received requests of this Service on the session.

publishCount

ServiceCounter
DataType
Counter of the Publish Service, identifying the number of received requests of this Service on the session.

republishCount

ServiceCounter
DataType
Counter of the Republish Service, identifying the number of received requests of this Service on the session.

transferSubscriptionsCount

ServiceCounter
DataType
Counter of the TransferSubscriptions Service, identifying the number of received requests of this Service on the session.

deleteSubscriptionsCount

ServiceCounter
DataType
Counter of the DeleteSubscriptions Service, identifying the number of received requests of this Service on the session.

addNodesCount

ServiceCounter
DataType
Counter of the AddNodes Service, identifying the number of received requests of this Service on the session.

addReferencesCount

ServiceCounter
DataType
Counter of the AddReferences Service, identifying the number of received requests of this Service on the session.

deleteNodesCount

ServiceCounter
DataType
Counter of the DeleteNodes Service, identifying the number of received requests of this Service on the session.

deleteReferencesCount

ServiceCounter
DataType
Counter of the DeleteReferences Service, identifying the number of received requests of this Service on the session.

browseCount

ServiceCounter
DataType
Counter of the Browse Service, identifying the number of received requests of this Service on the session.

browseNextCount

ServiceCounter
DataType
Counter of the BrowseNext Service, identifying the number of received requests of this Service on the session.

translateBrowsePathsToNodeIdsCount

ServiceCounter
DataType
Counter of the TranslateBrowsePathsToNodeIds Service, identifying the number of received requests of this Service on the session.

queryFirstCount

ServiceCounter
DataType
Counter of the QueryFirst Service, identifying the number of received requests of this Service on the session.

queryNextCount

ServiceCounter
DataType
Counter of the QueryNext Service, identifying the number of received requests of this Service on the session.

registerNodesCount

ServiceCounter
DataType
Counter of the RegisterNodes Service, identifying the number of received requests of this Service on the session.

unregisterNodesCount

ServiceCounter
DataType
Counter of the UnregisterNodes Service, identifying the number of received requests of this Service on the session.

Its representation in the AddressSpace is defined in Table 245.

Table 245 – SessionDiagnosticsDataType definition
Attributes Value
BrowseNameSessionDiagnosticsDataType
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info ServerType

12.12 SessionSecurityDiagnosticsDataType

This structure contains security-related diagnostic information about client sessions. Its elements are defined in Table 246. Because this information is security-related, it shall only be accessible by authorised users.

Table 246 – SessionSecurityDiagnosticsDataType Structure
NameTypeDescription
SessionSecurityDiagnosticsDataTypestructure

sessionId

NodeIdServer-assigned identifier of the session.

clientUserIdOfSession

StringName of authenticated user when creating the session.

clientUserIdHistory

String[]

Array containing the name of the authenticated user currently active (either from creating the session or from calling the ActivateSession Service) and the history of those names. Each time the active user changes, an entry shall be made at the end of the array. The active user is always at the end of the array. Servers may restrict the size of this array, but shall support at least a size of 2.

How the name of the authenticated user can be obtained from the system via the information received as part of the session establishment is defined in 6.4.3.

authenticationMechanism

StringType of authentication currently used by the session. The String shall be one of the lexical names of the UserIdentityTokenType Enum.

encoding

StringWhich encoding is used on the wire. The String shall be ‘XML’, ‘JSON’ or ‘UA Binary’.

transportProtocol

String

Which transport protocol is used. The String shall be the scheme from the URL used to establish the session. For example, ‘opc.tcp’, ‘opc.wss’ or ‘https’.

The formal protocol URL scheme strings are defined in OPC 10000-6.

securityMode

MessageSecurityModeThe message security mode used for the session.

securityPolicyUri

StringThe name of the security policy used for the session.

clientCertificate

ByteStringThe application instance certificate provided by the client in the CreateSession request.

Its representation in the AddressSpace is defined in Table 247.

Table 247 – SessionSecurityDiagnosticsDataType definition
Attributes Value
BrowseNameSessionSecurityDiagnosticsDataType
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info ServerType

12.13 ServiceCounterDataType

This structure contains diagnostic information about subscriptions. Its elements are defined in Table 248.

Table 248 – ServiceCounterDataType Structure
NameTypeDescription
ServiceCounterDataTypestructure

totalCount

UInt32The number of Service requests that have been received.

errorCount

UInt32The total number of Service requests that were rejected.

Its representation in the AddressSpace is defined in Table 249.

Table 249 – ServiceCounterDataType definition
Attributes Value
BrowseNameServiceCounterDataType
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info ServerType

12.14 StatusResult

This structure combines a StatusCode and diagnostic information and can, for example, be used by Methods to return several StatusCodes and the corresponding diagnostic information that are not handled in the Call Service parameters. The elements of this DataType are defined in Table 250. Whether the diagnosticInfo is returned depends on the setting of the Service calls.

Table 250 – StatusResult Structure
NameTypeDescription
StatusResultstructure

statusCode

StatusCodeThe StatusCode.

diagnosticInfo

DiagnosticInfoThe diagnostic information for the statusCode.

Its representation in the AddressSpace is defined in Table 251.

Table 251 – StatusResult definition
Attributes Value
BrowseNameStatusResult
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info StatusResult DataType

12.15 SubscriptionDiagnosticsDataType

This structure contains diagnostic information about subscriptions. Its elements are defined in Table 252.

Table 252 – SubscriptionDiagnosticsDataType Structure
NameTypeDescription
SubscriptionDiagnosticsDataTypestructure

sessionId

NodeIdServer-assigned identifier of the session the subscription belongs to.

subscriptionId

UInt32Server-assigned identifier of the subscription.

priority

ByteThe priority the client assigned to the subscription.

publishingInterval

DurationThe publishing interval of the subscription in milliseconds

maxKeepAliveCount

UInt32The maximum keep-alive count of the subscription.

maxLifetimeCount

UInt32The maximum lifetime count of the subscription.

maxNotificationsPerPublish

UInt32The maximum number of notifications per publish response.

publishingEnabled

BooleanWhether publishing is enabled for the subscription.

modifyCount

UInt32The number of ModifySubscription requests received for the subscription.

enableCount

UInt32The number of times the subscription has been enabled.

disableCount

UInt32The number of times the subscription has been disabled.

republishRequestCount

UInt32The number of Republish Service requests that have been received and processed for the subscription.

republishMessageRequestCount

UInt32The total number of messages that have been requested to be republished for the subscription.
Note that due to the design of the Republish Service this number is always equal to the republishRequestCount.

republishMessageCount

UInt32The number of messages that have been successfully republished for the subscription.

transferRequestCount

UInt32The total number of TransferSubscriptions Service requests that have been received for the subscription.

transferredToAltClientCount

UInt32The number of times the subscription has been transferred to an alternate client.

transferredToSameClientCount

UInt32The number of times the subscription has been transferred to an alternate session for the same client.

publishRequestCount

UInt32The number of Publish Service requests that have been received and processed for the subscription.

dataChangeNotificationsCount

UInt32The number of data change Notifications sent by the subscription. A data change Notification is one element of the monitoredItems array in a DataChangeNotification Structure sent in a Publish response.

eventNotificationsCount

UInt32The number of Event Notifications sent by the subscription. An Event Notification is one event entry in an EventNotificationList sent in a Publish response.

notificationsCount

UInt32The total number of Notifications sent by the subscription. This is the sum of dataChangeNotificationsCount and eventNotificationsCount.

latePublishRequestCount

UInt32The number of times the subscription has entered the LATE State, i.e. the number of times the publish timer expires and there are unsent notifications.

currentKeepAliveCount

UInt32The number of times the subscription has entered the KEEPALIVE State.

currentLifetimeCount

UInt32The current lifetime count of the subscription.

unacknowledgedMessageCount

UInt32The number of unacknowledged messages saved in the republish queue.

discardedMessageCount

UInt32The number of messages that were discarded before they were acknowledged.

monitoredItemCount

UInt32The total number of monitored items of the subscription, including the disabled monitored items.

disabledMonitoredItemCount

UInt32The number of disabled monitored items of the subscription.

monitoringQueueOverflowCount

UInt32The number of DataValue Notifications that have been discarded for all MonitoredItems when the queue size of a MonitoredItem is greater than one.

nextSequenceNumber

UInt32Sequence number for the next notification message.

eventQueueOverflowCount

UInt32The number of times a monitored item in the subscription has generated an Event of type EventQueueOverflowEventType.

Its representation in the AddressSpace is defined in Table 253.

Table 253 – SubscriptionDiagnosticsDataType definition
Attributes Value
BrowseNameSubscriptionDiagnosticsDataType
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info ServerType

12.16 ModelChangeStructureDataType

This structure contains elements that describe changes of the model. Its composition is defined in Table 254.

Table 254 – ModelChangeStructureDataType Structure
NameTypeDescription
ModelChangeStructure
DataType
structure

affected

NodeId NodeId of the Node that was changed. The client should assume that the affected Node has been created or deleted, had a Reference added or deleted, or the DataType has changed as described by the verb.

affectedType

NodeIdIf the affected Node was an Object or Variable, affectedType contains the NodeId of the TypeDefinitionNode of the affected Node. Otherwise it is set to null.

verb

Byte

Describes the changes happening to the affected Node.

The verb is an 8-bit unsigned integer used as bit mask with the structure defined in the following table:

A verb may identify several changes on the affected Node at once. This feature should be used if event compression is used (see OPC 10000-3 for details).

Note that all verbs shall always be considered in the context where the ModelChangeStructureDataType is used. A NodeDeleted may indicate that a Node was removed from a view but still exists in other Views.

Its representation in the AddressSpace is defined in Table 255.

Table 255 – ModelChangeStructureDataType definition
Attributes Value
BrowseNameModelChangeStructureDataType
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info Model Change General

12.17 SemanticChangeStructureDataType

This structure contains elements that describe a change of the model. Its composition is defined in Table 256.

Table 256 – SemanticChangeStructureDataType Structure
NameTypeDescription
SemanticChangeStructureDataTypestructure

affected

NodeId NodeId of the Node that owns the Property that has changed.

affectedType

NodeIdIf the affected Node was an Object or Variable, affectedType contains the NodeId of the TypeDefinitionNode of the affected Node. Otherwise it is set to null.

Its representation in the AddressSpace is defined in Table 257.

Table 257 – SemanticChangeStructureDataType definition
Attributes Value
BrowseNameSemanticChangeStructureDataType
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info SemanticChange

12.18 BitFieldMaskDataType

This simple DataType is a subtype of UInt64 and represents a bit mask up to 32 bits where individual bits can be written without modifying the other bits.

The first 32 bits (least significant bits) of the BitFieldMaskDataType represent the bit mask and the second 32 bits represent the validity of the bits in the bit mask. When the Server returns the value to the client, the validity provides information of which bits in the bit mask have a meaning. When the client passes the value to the Server, the validity defines which bits should be written. Only those bits defined in validity are changed in the bit mask, all others stay the same. The BitFieldMaskDataType can be used as DataType in the OptionSetType VariableType.

Its representation in the AddressSpace is defined in Table 258.

Table 258 – BitFieldMaskDataType definition
Attributes Value
BrowseNameBitFieldMaskDataType
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the UInt64 DataType defined in Table 187.
Conformance Units
Base Info BitFieldMaskDataType

12.19 NetworkGroupDataType

This structure contains information on different network paths for one Server. Its composition is defined in Table 259.

Table 259 – NetworkGroupDataType Structure
NameTypeDescription
NetworkGroupDataTypestructure

serverUri

StringURI of the Server represented by the network group.

networkPaths

EndpointUrlListDataType[]Array of different network paths to the Server, for example provided by different network cards in a Server. Each network path can have several Endpoints representing different protocol options for the same path.

Its representation in the AddressSpace is defined in Table 260.

Table 260 – NetworkGroupDataType definition
Attributes Value
BrowseNameNetworkGroupDataType
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Redundancy Server

12.20 EndpointUrlListDataType

This structure represents a list of URLs of an Endpoint. Its composition is defined in Table 261.

Table 261 – EndpointUrlListDataType Structure
NameTypeDescription
EndpointUrlListDataTypestructure

endpointUrlList

String[]List of URLs of an Endpoint.

Its representation in the AddressSpace is defined in Table 262.

Table 262 – EndpointUrlListDataType definition
Attributes Value
BrowseNameEndpointUrlListDataType
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Redundancy Server

12.21 KeyValuePair

This structured DataType is used to provide a key value pair. The KeyValuePair is formally defined in Table 263.

Table 263 – KeyValuePair Structure
NameTypeDescription
KeyValuePairstructure

key

QualifiedNameThe key of the value.

value

BaseDataTypeThe value associated with the key.

Its representation in the AddressSpace is defined in Table 264.

Table 264 – KeyValuePair definition
AttributesValue
BrowseNameKeyValuePair
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info KeyValuePair

12.22 RationalNumber

This Structured DataType defines a rational number as a fraction of two integral numbers. Its elements are described in Table 265.

Table 265 – RationalNumber Structure
NameTypeDescription
RationalNumberStructure

Numerator

Int32Numerator of the rational number. The sign of the rational number is reflected in this value

Denominator

UInt32Denominator of the rational number

Its representation in the AddressSpace is defined in Table 266.

Table 266 – RationalNumber definition
Attributes Value
BrowseNameRationalNumber
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info Rational Number

12.23 Vector

This abstract Structured DataType is the base to define multi-dimensional vectors. There are no specific elements defined as shown in Table 267.

Table 267 – Vector Structure
NameTypeDescription
VectorStructure

Its representation in the AddressSpace is defined in Table 268.

Table 268 – Vector definition
Attributes Value
BrowseNameVector
IsAbstractTRUE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info Spatial Data

12.24 3DVector

This Structured DataType defines a vector in 3D space, providing the length for each direction (X, Y, and Z). Its elements are described in Table 269.

Table 269 – 3DVector Structure
NameTypeDescription
3DVectorStructure

X

DoubleLength of X direction

Y

DoubleLength of Y direction

Z

DoubleLength of Z direction

Its representation in the AddressSpace is defined in Table 270.

Table 270 – 3DVector definition
Attributes Value
BrowseName3DVector
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Vector DataType defined in Table 268.
Conformance Units
Base Info Spatial Data

12.25 CartesianCoordinates

This abstract Structured DataType is the base to define multi-dimensional cartesian coordinates. CartesianCoordinates describe a position in a cartesian coordinate system. A cartesian coordinate system is a coordinate system that specifies each point uniquely in a multi-dimensional space by a set of numerical coordinates, which are the signed distances to the point from fixed perpendicular oriented lines, measured in the same unit of length. There are no specific elements defined as shown in Table 271.

Table 271 – CartesianCoordinates Structure
NameTypeDescription
CartesianCoordinatesStructure

Its representation in the AddressSpace is defined in Table 272.

Table 272 – CartesianCoordinates definition
Attributes Value
BrowseNameCartesianCoordinates
IsAbstractTRUE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info Spatial Data

12.26 3DCartesianCoordinates

This Structured DataType defines a position in 3D space, providing the coordinate of each dimension (X, Y, and Z). Its elements are described in Table 273.

Table 273 – 3DCartesianCoordinates Structure
NameTypeDescription
3DCartesianCoordinatesStructure

X

DoubleX coordinate

Y

DoubleY coordinate

Z

DoubleZ coordinate

Its representation in the AddressSpace is defined in Table 274.

Table 274 – 3DCartesianCoordinates definition
Attributes Value
BrowseName3DCartesianCoordinates
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the CartesianCoordinates DataType defined in Table 272.
Conformance Units
Base Info Spatial Data

12.27 Orientation

This abstract Structured DataType is the base to define multi-dimensional orientations. The orientation is given by the rotation of each dimension. There are no specific elements defined as shown in Table 275.

Table 275 – Orientation Structure
NameTypeDescription
OrientationStructure

Its representation in the AddressSpace is defined Table 276.

Table 276 – Orientation definition
Attributes Value
BrowseNameOrientation
IsAbstractTRUE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info Spatial Data

12.28 3DOrientation

This Structured DataType defines the orientation in 3D space, providing the rotation about each dimension. Its elements are described in Table 277.

Table 277 – 3DOrientation Structure
NameTypeDescription
3DOrientationStructure

A

DoubleRotation around A dimension

B

DoubleRotation around B dimension

C

DoubleRotation around C dimension

Its representation in the AddressSpace is defined Table 278.

Table 278 – 3DOrientation definition
Attributes Value
BrowseName3DOrientation
AbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Orientation DataType defined in Table 276.
Conformance Units
Base Info Spatial Data

12.29 Frame

This abstract Structured DataType is the base to define multi-dimensional frames. There are no specific elements defined as shown in Table 279. Subtypes shall add a field called CartesianCoordinates representing the cartesian coordinates of the frame using as DataType a subtype of CartesianCoordinates, and a field called Orientation, representing the orientation of the frame using as DataType a subtype of Orientation. The concrete DataTypes need to be defined by the subtype. Both fields shall have the same number of dimensions.

Table 279 – Frame Structure
NameTypeDescription
FrameStructure

Its representation in the AddressSpace is defined Table 280.

Table 280 – Frame definition
Attributes Value
BrowseNameFrame
IsAbstractTRUE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in Table 196.
Conformance Units
Base Info Spatial Data

12.30 3DFrame

This Structured DataType defines a frame in 3D space. Annex G provides examples on how to use the 3DFrame DataType. It is a subtype of the Frame DataType and refines the DataTypes of its elements, as described in Table 281.

Table 281 – 3DFrame Structure
NameTypeDescription
3DFrameStructure

CartesianCoordinates

3DCartesianCoordinatesCartesian coordinates of the frame in 3D space.

Orientation

3DOrientationOrientation of the frame in 3D space.

Its representation in the AddressSpace is defined Table 282.

Table 282 – 3DFrame definition
Attributes Value
BrowseName3DFrame
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Frame DataType defined in Table 280.
Conformance Units
Base Info Spatial Data

12.31 DataTypeSchemaHeader

This Structure DataType is the abstract base type used to provide OPC UA DataType definitions for an OPC UA Binary encoded byte blob used outside an OPC UA Server AddressSpace.

The DataTypeSchemaHeader is formally defined in Table 283.

Table 283 – DataTypeSchemaHeader structure
Name Type Description
DataTypeSchemaHeaderStructure

namespaces

String[]

Defines an array of namespace URIs. The index into the array is referred to as NamespaceIndex. The NamespaceIndex is used in NodeIds and QualifiedNames, rather than the longer namespace URI. NamespaceIndex 0 is reserved for the OPC UA namespace and it is not included in this array.

The array contains the namespaces used in the data that follows the DataTypeSchemaHeader. The index used in NodeId and QualifiedNames identify an element in this list. The first entry in this array maps to NamespaceIndex 1.

structureDataTypes

StructureDescription[]

Description of Structure and Union DataTypes used in the data that follows the DataTypeSchemaHeader. This includes nested Structures.

DataType NodeIds for Structure DataTypes used in the data refer to entries in this array.

The StructureDescription DataType is defined in 12.33.

enumDataTypes

EnumDescription[]

Description of Enumeration or OptionSet DataTypes used in the data that follows the DataTypeSchemaHeader.

DataType NodeIds for Enumeration or OptionSet DataTypes used in the data refer to entries in this array.

The EnumDescription DataType is defined in 12.34.

simpleDataTypes

SimpleTypeDescription[]Description of DataTypes derived from built-in DataTypes. This excludes OptionSet DataTypes.

The DataTypeSchemaHeader Structure representation in the AddressSpace is defined in Table 284.

Table 284 – DataTypeSchemaHeader definition
Attributes Value
BrowseNameDataTypeSchemaHeader
IsAbstractTRUE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of Structure defined in Table 196.
Conformance Units
Base Info UaBinary File

12.32 DataTypeDescription

This Structure DataType is the abstract base type for all DataType descriptions containing the DataType NodeId and the definition for custom DataTypes like Structures and Enumerations. The DataTypeDescription is formally defined in Table 285.

Table 285 – DataTypeDescription structure
Name Type Description
DataTypeDescriptionStructure

dataTypeId

NodeIdThe NodeId of the DataType.

name

QualifiedNameA unique name for the data type.

The DataTypeDescription Structure representation in the AddressSpace is defined in Table 286.

Table 286 – DataTypeDescription definition
Attributes Value
BrowseNameDataTypeDescription
IsAbstractTRUE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of Structure defined in Table 196.
Conformance Units
Base Info UaBinary File

12.33 StructureDescription

This Structure DataType provides the concrete DataTypeDescription for Structure DataTypes. It is a subtype of the DataTypeDescription DataType. The StructureDescription is formally defined in Table 287.

Table 287 – StructureDescription structure
Name Type Description
StructureDescriptionStructure

structureDefinition

StructureDefinition

The definition of the structure DataType.

The StructureDefinition DataType is defined in OPC 10000-3.

Its representation in the AddressSpace is defined in Table 288.

Table 288 – StructureDescription definition
Attributes Value
BrowseNameStructureDescription
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of DataTypeDescription defined in 12.32.
Conformance Units
Base Info UaBinary File

12.34 EnumDescription

This Structure DataType provides the concrete DataTypeDescription for Enumeration or OptionSet DataTypes. It is a subtype of the DataTypeDescription DataType. The EnumDescription is formally defined in Table 289.

Table 289 – EnumDescription structure
Name Type Description
EnumDescriptionStructure

enumDefinition

EnumDefinition

The definition of the enumeration DataType.

The EnumDefinition DataType is defined in OPC 10000-3.

builtInType

ByteThe builtInType indicates if the DataType is an Enumeration or an OptionSet. If the builtInType is Int32, the DataType is an Enumeration. If the builtInType is one of the UInteger DataTypes or ExtensionObject, the DataType is an OptionSet.

Its representation in the AddressSpace is defined in Table 290.

Table 290 – EnumDescription definition
Attributes Value
BrowseNameEnumDescription
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of DataTypeDescription defined in 12.32.
Conformance Units
Base Info UaBinary File

12.35 SimpleTypeDescription

This Structure DataType provides the information for DataTypes derived from built-in DataTypes. It is a subtype of the DataTypeDescription DataType. The SimpleTypeDescription is formally defined in Table 291.

Table 291 – SimpleTypeDescription structure
Name Type Description
SimpleTypeDescriptionStructure

baseDataType

NodeIdThe base DataType of the simple DataType.

builtInType

ByteThe builtInType used for the encoding of the simple DataType.

Its representation in the AddressSpace is defined in Table 292.

Table 292 – SimpleTypeDescription definition
Attributes Value
BrowseNameSimpleTypeDescription
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of DataTypeDescription defined in 12.32.
Conformance Units
Base Info UaBinary File

12.36 UABinaryFileDataType

This Structure DataType defines the base layout of an OPC UA Binary encoded file. The content of the file is the UABinaryFileDataType encoded as ExtensionObject.

The file-specific metadata is provided by the DataTypeSchemaHeader which is the base type for the UABinaryFileDataType Structure.

If the file is provided through a FileType Object, the MimeType Property of the Object shall have the value application/opcua+uabinary.

If the file is stored on disc, the file extension shall be uabinary.

The UABinaryFileDataType is formally defined in Table 293.

Table 293 – UABinaryFileDataType structure
Name Type Description
UABinaryFileDataTypeStructureSubtype of DataTypeSchemaHeader defined in 12.31.

schemaLocation

String

Reference to a file that contains the DataTypeSchemaHeader for the content of the file represented by an instance of this structure.

The schemaLocation is either a fully qualified URL or a URN which is a relative path to the file location.

If the schemaLocation is provided, the DataType descriptions can be skipped but the namespaces used shall match the namespaces in the schema file.

fileHeader

KeyValuePair[]The file-specific header.

body

BaseDataType

The body of the file.

The DataTypes used in the body are described through the structureDataTypes, enumDataTypes and simpleDataTypes fields of the DataTypeSchemaHeader Structure which is the base type for the UABinaryFileDataType.

DataTypes defined by OPC UA can be omitted.

Its representation in the UABinaryFileDataType is defined in Table 294.

Table 294 – UABinaryFileDataType definition
Attributes Value
BrowseNameUABinaryFileDataType
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of DataTypeSchemaHeader defined in 12.31.
Conformance Units
Base Info UaBinary File

12.37 PortableQualifiedName

This structure contains a QualifiedName where the namespace is represented as URI. Its composition is defined in Table 295.

Table 295 – PortableQualifiedName Structure
NameTypeDescription
PortableQualifiedNamestructure

namespaceUri

StringThe namespace URI portion of the QualifiedName.

name

StringThe text portion of the QualifiedName.

Its representation in the AddressSpace is defined in Table 296.

Table 296 – PortableQualifiedName definition
Attributes Value
BrowseNamePortableQualifiedName
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of Structure defined in Table 196.
Conformance Units
Base Info Portable IDs

12.38 PortableNodeId

This structure contains a NodeId where the namespace is represented as URI. Its elements are defined in Table 297. The structure is typically used to represent a NodeId outside the Server that defines the NodeId.

Table 297 – PortableNodeId Structure
NameTypeDescription
PortableNodeIdstructure

namespaceUri

StringThe namespace URI portion of the NodeId.

identifier

NodeIdThe identifier portion of the NodeId.The namespaceIndex parameter shall be 0 and is ignored in the Server

Its representation in the AddressSpace is defined in Table 298.

Table 298 – PortableNodeId definition
Attributes Value
BrowseNamePortableNodeId
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of Structure defined in Table 196.
Conformance Units
Base Info Portable IDs

12.39 UriString

This simple DataType is a subtype of String. It provides semantic information to the String describing the String as a URI as defined by RFC 3986. The UriString is formally defined in Table 299.

Table 299 – UriString definition
Attributes Value
BrowseNameUriString
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of String defined in Table 189.
Conformance Units
Base Info UriString

12.40 UnsignedRationalNumber

This Structure DataType is used to represent an unsigned rational number as a fraction of two integral numbers. The UnsignedRationalNumber is formally defined in Table 300.

Table 300 – UnsignedRationalNumber structure
Name Type Description
UnsignedRationalNumberStructure

Numerator

UInt32Numerator of the rational number

Denominator

UInt32Denominator of the rational number

Its representation in the AddressSpace is defined in Table 301.

Table 301 – UnsignedRationalNumber definition
Attributes Value
BrowseNameUnsignedRationalNumber
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of Structure defined in Table 196.
Conformance Units
Base Info Rational Number

12.41 SemanticVersionString DataType

The SemanticVersionString DataType is a subtype of String. It is formally defined in Table 302.

SemanticVersionString can be used if the version follows the rules of the Semantic Versioning 2.0.0. The syntax shall follow the BNF inTable 303.

Table 302 – SemanticVersionString definition
Attributes Value
BrowseNameSemanticVersionString
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the String DataType defined in Table 189.
Conformance Units
Base Info SemanticVersionString
Table 303 – Backus–Naur Form Grammar for SemanticVersionString
<valid semver> ::= <version core> | <version core> "-" <pre-release> | <version core> "+" <build> | <version core> "-" <pre-release> "+" <build> <version core> ::= <major> "." <minor> "." <patch> <major> ::= <numeric identifier> <minor> ::= <numeric identifier> <patch> ::= <numeric identifier> <pre-release> ::= <dot-separated pre-release identifiers> <dot-separated pre-release identifiers> ::= <pre-release identifier> | <pre-release identifier> "." <dot-separated pre-release identifiers> <build> ::= <dot-separated build identifiers> <dot-separated build identifiers> ::= <build identifier> | <build identifier> "." <dot-separated build identifiers> <pre-release identifier> ::= <alphanumeric identifier> | <numeric identifier> <build identifier> ::= <alphanumeric identifier> | <digits> <alphanumeric identifier> ::= <non-digit> | <non-digit> <identifier characters> | <identifier characters> <non-digit> | <identifier characters> <non-digit> <identifier characters> <numeric identifier> ::= "0" | <positive digit> | <positive digit> <digits> <identifier characters> ::= <identifier character> | <identifier character> <identifier characters> <identifier character> ::= <digit> | <non-digit> <non-digit> ::= <letter> | "-" <digits> ::= <digit> | <digit> <digits> <digit> ::= "0" | <positive digit> <positive digit> ::= "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" <letter> ::= "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z"

12.42 Handle

This simple DataType is a subtype of UInt32. It can be used to represent a collection of data managed by a Server. The Handle DataType is formally defined in Table 304.

Table 304 – Handle definition
Attributes Value
BrowseNameHandle
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the UInt32 DataType defined in Table 186.
Conformance Units
Base Info Handle DataType

12.43 TrimmedString

This simple DataType is a subtype of String. It is used to represent a String which has no leading or trailing whitespace. When a TrimmedString is specified as a Method input argument or written to a Variable and the incoming TrimmedString contains leading or trailing whitespace, the Server shall return a Bad_TypeMismatch error or shall trim the TrimmedString internally before processing it. Whitespace is defined as those Unicode characters defined as whitespace (i.e. “WSpace=Y”, “WS”) in the Unicode Database. The TrimmedString DataType is formally defined in Table 304.

Table 305 – TrimmedString definition
Attributes Value
BrowseNameTrimmedString
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the String DataType defined in Table 189.
Conformance Units
Base Info TrimmedString

12.44 RedundantServerMode

This DataType is an enumeration that defines the redundancy mode of a Server using non-transparent backup redundancy. Its values are defined in Table 306.

Table 306 – RedundantServerMode values
NameValueDescription
PRIMARY_WITH_BACKUP0The Server is acting as the primary in a non-transparent backup Server Set and one or more other Servers in the set are available to take over
PRIMARY_ONLY1The Server is acting as the primary in a non-transparent backup Server Set however no other Server are available to take over
BACKUP_READY2The Server is acting as a backup to the primary and is ready to take over as the primary
BACKUP_NOT_READY3The Server is acting as a backup to the primary and is not ready to take over as the primary

Its representation in the AddressSpace is defined in Table 307.

Table 307 – RedundantServerMode definition
Attributes Value
BrowseNameRedundantServerMode
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Enumeration DataType defined in Table 165.
HasPropertyVariableEnumStringsLocalizedText[]PropertyType
Conformance Units
Base Info ServerType

12.45 BitFieldDefinition

This Structured DataType is used to provide the metadata for a field of a BitFieldType VariableType. The BitFieldDefinition is formally defined in Table 308.

Table 308 – BitFieldDefinition Structure
NameTypeDescription
BitFieldDefinitionStructure

Name

StringA name for the field that is unique within the BitFieldDefinition.

Description

LocalizedTextA localized description of the field.

Reserved

BooleanTrue if the range of bits is reserved for future use by the defining Namespace.

StartingBitPosition

UInt32The bit position of the first bit used by this field.

EndingBitPosition

UInt32The bit position of the last bit used by this field.

When Reserved is set to True, it indicates that the bitfield shall only be defined by a Subtype of a BitFieldType defined in the same Namespace. Bits not defined or reserved in the BitFieldType may be used by a Subtype which is defined in any Namespace. A Subtype of a BitFieldType shall include, in its BitFieldDefinition all the field definitions of the parent Type. A Subtype of a BitFieldType shall not reallocate bits defined in the parent Type unless they are Reserved. A Reserved field can be refined by a SubType of a BitFieldType however it shall not include any more bits than the parent. In a Subtype of a BitFieldType, a Reserved field may be broken into more than one field if the overall number of bits remain the same as the parent. The Name and Description of a Reserved field may be changed by a Subtype of a BitFieldType.

The StartingBitPosition field shall be equal to or less than the EndingBitPosition field. The StartingBitPosition and EndingBitPosition fields shall be defined as zero being the least significate bit and increasing to most significate. When the BitFieldType is an array the bit numbering begins with the least significate bit of the first element of the array and ends with the most significate bit of the last element of the array.

The DataType of the field is defined by the DataType of the BitFieldType’s child DataVariable for the field. When the DataType of the field is an Integer the most significate bit of the field shall be the sign bit.

Its representation in the AddressSpace is defined in Table 309.

Table 309 – BitFieldDefinition definition
Attributes Value
BrowseNameBitFieldDefinition
IsAbstractFALSE
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the Structure DataType defined in 12.2.12.
Conformance Units

The following example is intended to illustrate the use of the BitFieldType VariableType. In this example the MyBitFieldType, defined in Table 310 and Table 311, consists of three defined fields, a reserved bit, a reserved range of bits and three bits which are not defined. The reserved fields can be used by SubTypes that are defined within the same Namespace as the MyBitFieldType VariableType. Figure 11 illustrates how the fields are extracted from the example BitFieldType. An example of a SubType utilizing the reserved bit is the MyBitFieldSubType defined in Table 312 and Table 313. The three bits which are not defined can be utilized by SubTypes defined in any Namespace.

Table 310 – MyBitFieldType VariableType Example
Attribute Value
BrowseNameMyBitFieldType
IsAbstractFalse
ValueRank−1 (−1 = Scalar)
DataTypeUInt16
References NodeClass BrowseName DataType TypeDefinition MR
Subtype of the BitFieldType defined in 7.29
HasPropertyVariableMyBitFieldDefinitionsBitFieldDefinition[]PropertyTypeM
HasComponentVariableCounterInt16BaseDataVariableTypeM
HasComponentVariableEnabledBooleanBaseDataVariableTypeM
HasComponentVariableStatusBooleanBaseDataVariableTypeM
Table 311 – MyBitFieldDefinitions BitFieldDefinition Example
Name Description Reserved

StartingBit

Position

EndingBitPosition
CounterA 6-bit counter representing a signed integer value. As a signed integer the 6th bit (position 5) is the sign bit.N05
MyReservedBitA single bit reserved for future extensionY66
EnabledA single bit representing a Boolean enable valueN77
StatusA single bit representing a Boolean status valueN88
MyReserveBlockA range of 4 reserved bits for future extensionY1215

Note: Bits 9 to 11 are not defined in this example and therefore available to be used by any SubType in any Namespace.

Figure 11 – MyBitFieldType Example Illustration
Table 312 – MyBitFieldSubType VariableType Example
Attribute Value
BrowseNameMyBitFieldSubType
IsAbstractFalse
ValueRank−1 (−1 = Scalar)
DataTypeUInt16
References NodeClass BrowseName DataType TypeDefinition MR
Subtype of the MyBitFieldType defined in Table 310
HasPropertyVariableMyBitFieldSubDefinitionsBitFieldDefinition[]PropertyTypeM
HasComponentVariableSubStatusBooleanBaseDataVariableTypeM
Table 313 – MyBitFieldSubDefinitions BitFieldDefinition Example
Name Description Reserved

StartingBit

Position

EndingBitPosition
CounterA 6-bit counter representing a signed integer value. As a signed integer the 6th bit (position 5) is the sign bit.N05
SubStatusA single bit representing a Boolean substatus. This field is utilizing the MyReservedBit reserved bit defined in the parent TypeN66
EnabledA single bit representing a Boolean enable valueN77
StatusA single bit representing a Boolean status valueN88
MyReserveBlockA range of 4 reserved bits for future extensionY1215

The following is another BitFieldType VariableType example intended to illustrate the use of an Array DataType. In this example the MyBitFieldArrayType, defined in Table 314 and Table 315, uses a UInt16 array and consists of two defined fields, and a reserved bit. The reserved bit can be used by SubTypes that are defined within the same Namespace as the MyBitFieldArrayType VariableType.The example illustrates how the StartBitPosition and EndingBitPosition are used with Array DataTypes. The first element of the array identified as bit positions 0 to 15 represent the lower 16 bits of the Counter. The second element of the array represents the upper 8 bits of the Counter. Figure 12 illustrates how the fields are extracted from the example BitFieldType.

Table 314 – MyBitFieldArrayType VariableType Example
Attribute Value
BrowseNameMyBitFieldArrayType
IsAbstractFalse
ValueRank1 (1 = Array)
DataTypeUInt16[]
References NodeClass BrowseName DataType TypeDefinition MR
Subtype of the BitFieldType defined in defined 7.29
HasPropertyVariableMyBitFieldArrayDefinitionsBitFieldDefinition[]PropertyTypeM
HasComponentVariableCounterInt32BaseDataVariableTypeM
HasComponentVariableEnabledBooleanBaseDataVariableTypeM
Table 315 – MyBitFieldArrayDefinitions BitFieldDefinition Example
Name Description Reserved

StartingBit

Position

EndingBitPosition
CounterA 24-bit counter representing a signed integer value. As a signed integer the 24th bit (position 23) is the sign bit.N023
MyReservedBitA single bit reserved for future extensionY2424
EnabledA single bit representing a Boolean enable valueN2525
Figure 12 – MyBitFieldArrayType Example Illustration