Standard DataTypes are described in the following subclauses.

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

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

Table 143 – BaseDataType definition

Attributes

Value

BrowseName

BaseDataType

IsAbstract

TRUE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Conformance Units

Base Info Base Types

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

Table 144 – Boolean definition

Attributes

Value

BrowseName

Boolean

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the BaseDataType DataType defined in Table 143.

Conformance Units

Base Info Base Types

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

Table 145 – ByteString definition

Attributes

Value

BrowseName

ByteString

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the BaseDataType DataType defined in Table 143.

Conformance Units

Base Info Base Types

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

Table 146 – AudioDataType definition

Attributes

Value

BrowseName

AudioDataType

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the ByteString DataType defined in Table 145.

Conformance Units

Base Info Audio Type

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

Table 147 – Image definition

Attributes

Value

BrowseName

Image

IsAbstract

TRUE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the ByteString DataType defined in Table 145.

Conformance Units

Base Info Image DataTypes

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

Table 148 – ImageBMP definition

Attributes

Value

BrowseName

ImageBMP

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Image DataType defined in Table 147.

Conformance Units

Base Info Image DataTypes

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

Table 149 – ImageGIF definition

Attributes

Value

BrowseName

ImageGIF

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Image DataType defined in Table 147.

Conformance Units

Base Info Image DataTypes

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

Table 150 – ImageJPG definition

Attributes

Value

BrowseName

ImageJPG

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Image DataType defined in Table 147.

Conformance Units

Base Info Image DataTypes

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

Table 151 – ImagePNG definition

Attributes

Value

BrowseName

ImagePNG

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Image DataType defined in Table 147.

Conformance Units

Base Info Image DataTypes

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

Table 152 – DateTime definition

Attributes

Value

BrowseName

DateTime

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the BaseDataType DataType defined in Table 143.

Conformance Units

Base Info Base Types

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

Table 153 – UtcTime definition

Attributes

Value

BrowseName

UtcTime

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the DateTime DataType defined in Table 152.

Conformance Units

Base Info Base Types

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

Table 154 – Enumeration definition

Attributes

Value

BrowseName

Enumeration

IsAbstract

TRUE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the BaseDataType DataType defined in Table 143.

Conformance Units

Base Info Base Types

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

Table 155 – IdType definition

Attributes

Value

BrowseName

IdType

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Enumeration DataType defined in Table 154.

HasProperty

Variable

EnumStrings

LocalizedText[]

PropertyType

Conformance Units

Base Info Base Types

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

Table 156 – NodeClass definition

Attributes

Value

BrowseName

NodeClass

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Enumeration DataType defined in Table 154.

HasProperty

Variable

EnumValues

EnumValueType []

PropertyType

Conformance Units

Base Info Base Types

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

Table 157 – StructureType definition

Attributes

Value

BrowseName

StructureType

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Enumeration DataType defined in Table 154.

HasProperty

Variable

EnumStrings

LocalizedText[]

PropertyType

Conformance Units

Address Space DataTypeDefinition Attribute

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

Table 158 – Guid definition

Attributes

Value

BrowseName

Guid

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the BaseDataType DataType defined in Table 143.

Conformance Units

Base Info Base Types

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

Table 159 – LocalizedText definition

Attributes

Value

BrowseName

LocalizedText

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the BaseDataType DataType defined in Table 143.

Conformance Units

Base Info Base Types

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

Table 160 – NodeId definition

Attributes

Value

BrowseName

NodeId

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the BaseDataType DataType defined in Table 143.

Conformance Units

Base Info Base Types

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

Table 161 – Number definition

Attributes

Value

BrowseName

Number

IsAbstract

TRUE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the BaseDataType DataType defined in Table 143.

Conformance Units

Base Info Base Types

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

Table 162 – Decimal definition

Attributes

Value

BrowseName

Decimal

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Number DataType defined in Table 161.

Conformance Units

Base Info Decimal DataType

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

Table 163 – Double definition

Attributes

Value

BrowseName

Double

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Number DataType defined in Table 161.

Conformance Units

Base Info Base Types

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

Table 164 – Duration definition

Attributes

Value

BrowseName

Duration

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Double DataType defined in Table 163.

Conformance Units

Base Info Base Types

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

Table 165 – Float definition

Attributes

Value

BrowseName

Float

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Number DataType defined in Table 161.

Conformance Units

Base Info Base Types

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

Table 166 – Integer definition

Attributes

Value

BrowseName

Integer

IsAbstract

TRUE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Number DataType defined in Table 161.

Conformance Units

Base Info Base Types

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

Table 167 – Int16 definition

Attributes

Value

BrowseName

Int16

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Integer DataType defined in Table 166.

Conformance Units

Base Info Base Types

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

Table 168 – Int32 definition

Attributes

Value

BrowseName

Int32

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Integer DataType defined in Table 166.

Conformance Units

Base Info Base Types

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

Table 169 – Int64 definition

Attributes

Value

BrowseName

Int64

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Integer DataType defined in Table 166.

Conformance Units

Base Info Base Types

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

Table 170 – SByte definition

Attributes

Value

BrowseName

SByte

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Integer DataType defined in Table 166.

Conformance Units

Base Info Base Types

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

Table 171 – UInteger definition

Attributes

Value

BrowseName

UInteger

IsAbstract

TRUE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Number DataType defined in Table 161.

Conformance Units

Base Info Base Types

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

Table 172 – Byte definition

Attributes

Value

BrowseName

Byte

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the UInteger DataType defined in Table 171.

Conformance Units

Base Info Base Types

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

Table 173 – UInt16 definition

Attributes

Value

BrowseName

UInt16

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the UInteger DataType defined in Table 171.

Conformance Units

Base Info Base Types

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

Table 174 – AccessRestrictionType definition

Attributes

Value

BrowseName

AccessRestrictionType

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

HasProperty

Variable

OptionSetValues

LocalizedText[]

PropertyType

Subtype of the UInt16 DataType defined in Table 173.

Conformance Units

Security Role Server Base 2

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

Table 175 – UInt32 definition

Attributes

Value

BrowseName

UInt32

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the UInteger DataType defined in Table 171.

Conformance Units

Base Info Base Types

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

Table 176 – UInt64 definition

Attributes

Value

BrowseName

UInt64

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the UInteger DataType defined in Table 171.

Conformance Units

Base Info Base Types

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

Table 177 – QualifiedName definition

Attributes

Value

BrowseName

QualifiedName

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the BaseDataType DataType defined in Table 143.

Conformance Units

Base Info Base Types

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

Table 178 – String definition

Attributes

Value

BrowseName

String

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the BaseDataType DataType defined in Table 143.

Conformance Units

Base Info Base Types

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

Table 179 – LocaleId definition

Attributes

Value

BrowseName

LocaleId

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the String DataType defined in Table 178.

Conformance Units

Base Info ServerType

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

Table 180 – NormalizedString definition

Attributes

Value

BrowseName

NormalizedString

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the String DataType defined in Table 178.

Conformance Units

Base Info NormalizedString DataType

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

Table 181 – DecimalString definition

Attributes

Value

BrowseName

DecimalString

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the String DataType defined in Table 178.

Conformance Units

Base Info DecimalString DataType

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

Table 182 – DurationString definition

Attributes

Value

BrowseName

DurationString

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the String DataType defined in Table 178.

Conformance Units

Base Info Date DataTypes

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

Table 183 – TimeString definition

Attributes

Value

BrowseName

TimeString

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the String DataType defined in Table 178.

Conformance Units

Base Info Date DataTypes

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

Table 184 – DateString definition

Attributes

Value

BrowseName

DateString

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the String DataType defined in Table 178.

Conformance Units

Base Info Date DataTypes

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

Table 185 – Structure definition

Attributes

Value

BrowseName

Structure

IsAbstract

TRUE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the BaseDataType DataType defined in Table 143.

Conformance Units

Base Info Base Types

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

Table 186 – Argument definition

Attributes

Value

BrowseName

Argument

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info Method Argument DataType

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

Table 187 – CurrencyUnitType definition

Attributes

Value

BrowseName

CurrencyUnitType

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info Currency

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

Table 188 – DataTypeDefinition definition

Attributes

Value

BrowseName

DataTypeDefinition

IsAbstract

TRUE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Address Space DataTypeDefinition Attribute

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

Table 189 – EnumDefinition definition

Attributes

Value

BrowseName

EnumDefinition

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the DataTypeDefinition defined in Table 188.

Conformance Units

Address Space DataTypeDefinition Attribute

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

Table 190 – StructureDefinition definition

Attributes

Value

BrowseName

StructureDefinition

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the DataTypeDefinition defined in Table 188.

Conformance Units

Address Space DataTypeDefinition Attribute

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

Table 191 – EnumValueType definition

Attributes

Value

BrowseName

EnumValueType

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info Base Types

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

Table 192 – EnumField definition

Attributes

Value

BrowseName

EnumField

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the EnumValueType defined in Table 191.

Conformance Units

Address Space DataTypeDefinition Attribute

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

Table 193 – OptionSet definition

Attributes

Value

BrowseName

OptionSet

IsAbstract

TRUE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info OptionSet DataType

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

Table 194 – RolePermissionType definition

Attributes

Value

BrowseName

RolePermissionType

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Security Role Server Base 2

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

Table 195 – StructureField definition

Attributes

Value

BrowseName

StructureField

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Address Space DataTypeDefinition Attribute

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

Table 196 – TimeZoneDataType definition

Attributes

Value

BrowseName

TimeZoneDataType

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info LocalTime

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

Table 197 – Union definition

Attributes

Value

BrowseName

Union

IsAbstract

TRUE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info OptionSet DataType

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

Table 198 – XmlElement definition

Attributes

Value

BrowseName

XmlElement

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the BaseDataType DataType defined in Table 143.

Conformance Units

Base Info Base Types

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

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

Table 199 – AddNodesItem definition

Attributes

Value

BrowseName

AddNodesItem

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Auditing NodeManagement

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

Table 200 – AddReferencesItem definition

Attributes

Value

BrowseName

AddReferencesItem

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Auditing NodeManagement

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

Table 201 – ApplicationDescription definition

Attributes

Value

BrowseName

ApplicationDescription

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info ServerType

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

Table 202 – ContentFilter definition

Attributes

Value

BrowseName

ContentFilter

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info ContentFilter

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

Table 203 – DataValue definition

Attributes

Value

BrowseName

DataValue

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the BaseDataType DataType defined in Table 143.

Conformance Units

Base Info Base Types

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

Table 204 – DeleteNodesItem definition

Attributes

Value

BrowseName

DeleteNodesItem

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Auditing NodeManagement

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

Table 205 – DeleteReferencesItem definition

Attributes

Value

BrowseName

DeleteReferencesItem

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Auditing NodeManagement

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

Table 206 – DiagnosticInfo definition

Attributes

Value

BrowseName

DiagnosticInfo

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the BaseDataType DataType defined in Table 185.

Conformance Units

Base Info Base Types

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

Table 207 – ExpandedNodeId definition

Attributes

Value

BrowseName

ExpandedNodeId

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the BaseDataType DataType defined in Table 185.

Conformance Units

Base Info Base Types

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

Table 208 – MessageSecurityMode definition

Attributes

Value

BrowseName

MessageSecurityMode

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Enumeration DataType defined in Table 154.

HasProperty

Variable

EnumStrings

LocalizedText[]

PropertyType

Conformance Units

Base Info ServerType

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

Table 209 – NumericRange definition

Attributes

Value

BrowseName

NumericRange

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the String DataType defined in Table 178.

Conformance Units

Base Info Base Types

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

Table 210 – SecurityTokenRequestType definition

Attributes

Value

BrowseName

SecurityTokenRequestType

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Enumeration DataType defined in Table 154.

HasProperty

Variable

EnumStrings

LocalizedText[]

PropertyType

Conformance Units

Base Info Base Types

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

Table 211 – SignedSoftwareCertificate definition

Attributes

Value

BrowseName

SignedSoftwareCertificate

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info Base Types

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

Table 212 – StatusCode definition

Attributes

Value

BrowseName

StatusCode

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the BaseDataType DataType defined in Table 175.

Conformance Units

Base Info Base Types

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

Table 213 – UserIdentityToken definition

Attributes

Value

BrowseName

UserIdentityToken

IsAbstract

TRUE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Auditing Connections

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

Table 214 – AnonymousIdentityToken definition

Attributes

Value

BrowseName

AnonymousIdentityToken

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the UserIdentityToken DataType defined in Table 213.

Conformance Units

Base Info Base Types

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

Table 215 – IssuedIdentityToken definition

Attributes

Value

BrowseName

IssuedIdentityToken

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the UserIdentityToken DataType defined in Table 213.

Conformance Units

Base Info Base Types

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

Table 216 – UserNameIdentityToken definition

Attributes

Value

BrowseName

UserNameIdentityToken

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the UserIdentityToken DataType defined in Table 213.

Conformance Units

Base Info Base Types

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

Table 217 – X509IdentityToken definition

Attributes

Value

BrowseName

X509IdentityToken

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the UserIdentityToken DataType defined in Table 213.

Conformance Units

Base Info Base Types

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

Table 218 – VersionTime definition

Attributes

Value

BrowseName

VersionTime

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the UInt32 DataType defined in Table 175.

Conformance Units

Base Info ServerType

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

Table 219 – BuildInfo Structure

Name

Type

Description

BuildInfo

structure

Information that describes the build of the software.

productUri

String

URI that identifies the software

manufacturerName

String

Name of the software manufacturer.

productName

String

Name of the software.

softwareVersion

String

Software version

buildNumber

String

Build number

buildDate

UtcTime

Date and time of the build.

Its representation in the AddressSpace is defined in Table 220.

Table 220 – BuildInfo definition

Attributes

Value

BrowseName

BuildInfo

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info ServerType

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

Table 221 – RedundancySupport values

Name

Value

Description

NONE

0

None means that there is no redundancy support.

COLD

1

Cold means that the server supports cold redundancy as defined in OPC 10000-4.

WARM

2

Warm means that the server supports warm redundancy as defined in OPC 10000-4.

HOT

3

Hot means that the server supports hot redundancy as defined in OPC 10000-4.

TRANSPARENT

4

Transparent means that the server supports transparent redundancy as defined in OPC 10000-4.

HOT_AND_MIRRORED

5

HotAndMirrored 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 222.

Table 222 – RedundancySupport definition

Attributes

Value

BrowseName

RedundancySupport

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Enumeration DataType defined in Table 154.

HasProperty

Variable

EnumStrings

LocalizedText[]

PropertyType

Conformance Units

Base Info ServerType

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

Table 223 – ServerState values

Name

Value

Description

RUNNING

0

The Server is running normally. This is the usual state for a Server.

FAILED

1

A 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_CONFIGURATION

2

The Server is running but has no configuration information loaded and therefore does not transfer data.

SUSPENDED

3

The Server has been temporarily suspended by some vendor-specific method and is not receiving or sending data.

SHUTDOWN

4

The 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.

TEST

5

The 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_FAULT

6

The 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.

UNKNOWN

7

This 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 224.

Table 224 – ServerState definition

Attributes

Value

BrowseName

ServerState

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Enumeration DataType defined in Table 154.

HasProperty

Variable

EnumStrings

LocalizedText[]

PropertyType

Conformance Units

Base Info ServerType

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

Table 225 – RedundantServerDataType Structure

Name

Type

Description

RedundantServerDataType

structure

serverId

String

Identifies the Server uniquely.

serviceLevel

Byte

The service level of the server.

serverState

ServerState

The current state of the server.

Its representation in the AddressSpace is defined in Table 226.

Table 226 – RedundantServerDataType definition

Attributes

Value

BrowseName

RedundantServerDataType

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Redundancy Server Transparent

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

Table 227 – SamplingIntervalDiagnosticsDataType Structure

Name

Type

Description

SamplingIntervalDiagnosticsDataType

structure

samplingInterval

Duration

The sampling interval in milliseconds.

monitoredItemCount

UInt32

The number of MonitoredItems being sampled at this sample rate.

maxMonitoredItemCount

UInt32

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

disabledMonitoredItemCount

UInt32

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

Its representation in the AddressSpace is defined in Table 228.

Table 228 – SamplingIntervalDiagnosticsDataType definition

Attributes

Value

BrowseName

SamplingIntervalDiagnosticsDataType

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info ServerType

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

Table 229 – ServerDiagnosticsSummaryDataType Structure

Name

Type

Description

ServerDiagnosticsSummaryDataType

structure

serverViewCount

UInt32

The number of server-created views in the server.

currentSessionCount

UInt32

The number of client sessions currently established in the server.

cumulatedSessionCount

UInt32

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

securityRejectedSessionCount

UInt32

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

rejectedSessionCount

UInt32

The 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

UInt32

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

sessionAbortCount

UInt32

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

currentSubscriptionCount

UInt32

The number of subscriptions currently established in the server.

cumulatedSubscriptionCount

UInt32

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

publishingIntervalCount

UInt32

The number of publishing intervals currently supported in the server.

securityRejectedRequestsCount

UInt32

The 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

UInt32

The 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 230.

Table 230 – ServerDiagnosticsSummaryDataType definition

Attributes

Value

BrowseName

ServerDiagnosticsSummaryDataType

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info ServerType

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

Table 231 – ServerStatusDataType Structure

Name

Type

Description

ServerStatusDataType

structure

startTime

UtcTime

Time (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

UtcTime

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

state

ServerState

The 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

LocalizedText

A 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 232.

Table 232 – ServerStatusDataType definition

Attributes

Value

BrowseName

ServerStatusDataType

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info ServerType

This structure contains diagnostic information about client sessions. Its elements are defined in Table 233. 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 233 – SessionDiagnosticsDataType Structure

Name

Type

Description

SessionDiagnosticsDataType

structure

sessionId

NodeId

Server-assigned identifier of the session.

sessionName

String

The name of the session provided in the CreateSession request.

clientDescription

Application

Description

The description provided by the client in the CreateSession request.

serverUri

String

The serverUri request in the CreateSession request.

endpointUrl

String

The endpointUrl passed by the client to the CreateSession request.

localeIds

LocaleId[]

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

actualSessionTimeout

Duration

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

maxResponseMessageSize

UInt32

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

clientConnectionTime

UtcTime

The server timestamp when the client opens the session.

clientLastContactTime

UtcTime

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

currentSubscriptionsCount

UInt32

The number of subscriptions currently used by the session.

currentMonitoredItemsCount

UInt32

The number of MonitoredItems currently used by the session

currentPublishRequestsInQueue

UInt32

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

totalRequestCount

ServiceCounterDataType

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

unauthorizedRequestCount

UInt32

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

readCount

ServiceCounterDataType

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

historyReadCount

ServiceCounterDataType

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

writeCount

ServiceCounterDataType

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

historyUpdateCount

ServiceCounterDataType

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

callCount

ServiceCounterDataType

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

createMonitoredItemsCount

ServiceCounterDataType

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

modifyMonitoredItemsCount

ServiceCounterDataType

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

setMonitoringModeCount

ServiceCounterDataType

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

setTriggeringCount

ServiceCounterDataType

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

deleteMonitoredItemsCount

ServiceCounterDataType

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

createSubscriptionCount

ServiceCounterDataType

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

modifySubscriptionCount

ServiceCounterDataType

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

setPublishingModeCount

ServiceCounterDataType

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

publishCount

ServiceCounterDataType

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

republishCount

ServiceCounterDataType

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

transferSubscriptionsCount

ServiceCounterDataType

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

deleteSubscriptionsCount

ServiceCounterDataType

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

addNodesCount

ServiceCounterDataType

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

addReferencesCount

ServiceCounterDataType

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

deleteNodesCount

ServiceCounterDataType

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

deleteReferencesCount

ServiceCounterDataType

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

browseCount

ServiceCounterDataType

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

browseNextCount

ServiceCounterDataType

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

translateBrowsePathsToNodeIdsCount

ServiceCounterDataType

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

queryFirstCount

ServiceCounterDataType

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

queryNextCount

ServiceCounterDataType

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

registerNodesCount

ServiceCounterDataType

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

unregisterNodesCount

ServiceCounterDataType

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 234.

Table 234 – SessionDiagnosticsDataType definition

Attributes

Value

BrowseName

SessionDiagnosticsDataType

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info ServerType

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

Table 235 – SessionSecurityDiagnosticsDataType Structure

Name

Type

Description

SessionSecurityDiagnosticsDataType

structure

sessionId

NodeId

Server-assigned identifier of the session.

clientUserIdOfSession

String

Name 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

String

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

encoding

String

Which 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

MessageSecurityMode

The message security mode used for the session.

securityPolicyUri

String

The name of the security policy used for the session.

clientCertificate

ByteString

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

Its representation in the AddressSpace is defined in Table 236.

Table 236 – SessionSecurityDiagnosticsDataType definition

Attributes

Value

BrowseName

SessionSecurityDiagnosticsDataType

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info ServerType

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

Table 237 – ServiceCounterDataType Structure

Name

Type

Description

ServiceCounterDataType

structure

totalCount

UInt32

The number of Service requests that have been received.

errorCount

UInt32

The total number of Service requests that were rejected.

Its representation in the AddressSpace is defined in Table 238.

Table 238 – ServiceCounterDataType definition

Attributes

Value

BrowseName

ServiceCounterDataType

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info ServerType

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 239. Whether the diagnosticInfo is returned depends on the setting of the Service calls.

Table 239 – StatusResult Structure

Name

Type

Description

StatusResult

structure

statusCode

StatusCode

The StatusCode.

diagnosticInfo

DiagnosticInfo

The diagnostic information for the statusCode.

Its representation in the AddressSpace is defined in Table 240.

Table 240 – StatusResult definition

Attributes

Value

BrowseName

StatusResult

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info StatusResult DataType

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

Table 241 – SubscriptionDiagnosticsDataType Structure

Name

Type

Description

SubscriptionDiagnosticsDataType

structure

sessionId

NodeId

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

subscriptionId

UInt32

Server-assigned identifier of the subscription.

priority

Byte

The priority the client assigned to the subscription.

publishingInterval

Duration

The publishing interval of the subscription in milliseconds

maxKeepAliveCount

UInt32

The maximum keep-alive count of the subscription.

maxLifetimeCount

UInt32

The maximum lifetime count of the subscription.

maxNotificationsPerPublish

UInt32

The maximum number of notifications per publish response.

publishingEnabled

Boolean

Whether publishing is enabled for the subscription.

modifyCount

UInt32

The number of ModifySubscription requests received for the subscription.

enableCount

UInt32

The number of times the subscription has been enabled.

disableCount

UInt32

The number of times the subscription has been disabled.

republishRequestCount

UInt32

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

republishMessageRequestCount

UInt32

The 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

UInt32

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

transferRequestCount

UInt32

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

transferredToAltClientCount

UInt32

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

transferredToSameClientCount

UInt32

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

publishRequestCount

UInt32

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

dataChangeNotificationsCount

UInt32

The 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

UInt32

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

notificationsCount

UInt32

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

latePublishRequestCount

UInt32

The 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

UInt32

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

currentLifetimeCount

UInt32

The current lifetime count of the subscription.

unacknowledgedMessageCount

UInt32

The number of unacknowledged messages saved in the republish queue.

discardedMessageCount

UInt32

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

monitoredItemCount

UInt32

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

disabledMonitoredItemCount

UInt32

The number of disabled monitored items of the subscription.

monitoringQueueOverflowCount

UInt32

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

nextSequenceNumber

UInt32

Sequence number for the next notification message.

eventQueueOverFlowCount

UInt32

The 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 242.

Table 242 – SubscriptionDiagnosticsDataType definition

Attributes

Value

BrowseName

SubscriptionDiagnosticsDataType

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info ServerType

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

Table 243 – ModelChangeStructureDataType Structure

Name

Type

Description

ModelChangeStructureDataType

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

NodeId

If 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:

Field

Bit

Description

NodeAdded

0

Indicates the affected Node has been added.

NodeDeleted

1

Indicates the affected Node has been deleted.

ReferenceAdded

2

Indicates a Reference has been added. The affected Node may be either a SourceNode or TargetNode. Note that an added bidirectional Reference is reflected by two changes one with the affected Node being the SourceNode, and the second with the affected Node being the TargetNode.

ReferenceDeleted

3

Indicates a Reference has been deleted. The affected Node may be either a SourceNode or TargetNode. Note that a deleted bidirectional Reference is reflected by two changes one with the affected Node being the SourceNode, and the second with the affected Node being the TargetNode.

DataTypeChanged

4

This verb may be used only for affected Nodes that are Variables or VariableTypes. It indicates that the DataType Attribute has changed.

Reserved

5:7

Reserved for future use. Shall always be zero.

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 244.

Table 244 – ModelChangeStructureDataType definition

Attributes

Value

BrowseName

ModelChangeStructureDataType

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info Model Change General

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

Table 245 – SemanticChangeStructureDataType Structure

Name

Type

Description

SemanticChangeStructureDataType

structure

affected

NodeId

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

affectedType

NodeId

If 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 246.

Table 246 – SemanticChangeStructureDataType definition

Attributes

Value

BrowseName

SemanticChangeStructureDataType

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info SemanticChange

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 247.

Table 247 – BitFieldMaskDataType definition

Attributes

Value

BrowseName

BitFieldMaskDataType

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the UInt64 DataType defined in Table 176.

Conformance Units

Base Info BitFieldMaskDataType

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

Table 248 – NetworkGroupDataType Structure

Name

Type

Description

NetworkGroupDataType

structure

serverUri

String

URI 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 node. Each network path can have several Endpoints representing different protocol options for the same path.

Its representation in the AddressSpace is defined in Table 249.

Table 249 – NetworkGroupDataType definition

Attributes

Value

BrowseName

NetworkGroupDataType

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Redundancy Server

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

Table 250 – EndpointUrlListDataType Structure

Name

Type

Description

EndpointUrlListDataType

structure

endpointUrlList

String[]

List of URLs of an Endpoint.

Its representation in the AddressSpace is defined in Table 251.

Table 251 – EndpointUrlListDataType definition

Attributes

Value

BrowseName

EndpointUrlListDataType

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Redundancy Server

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

Table 252 – KeyValuePair Structure

Name

Type

Description

KeyValuePair

structure

key

QualifiedName

The key of the value.

value

BaseDataType

The value associated with the key.

Its representation in the AddressSpace is defined in Table 253.

Table 253 – KeyValuePair definition

Attributes

Value

BrowseName

KeyValuePair

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info KeyValuePair

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

Table 254 – RationalNumber Structure

Name

Type

Description

RationalNumber

Structure

Numerator

Int32

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

Denominator

UInt32

Denominator of the rational number

Its representation in the AddressSpace is defined in Table 255.

Table 255 – RationalNumber definition

Attributes

Value

BrowseName

RationalNumber

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info Rational Number

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

Table 256 – Vector Structure

Name

Type

Description

Vector

Structure

Its representation in the AddressSpace is defined in Table 257.

Table 257 – Vector definition

Attributes

Value

BrowseName

Vector

IsAbstract

TRUE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info Spatial Data

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 258.

Table 258 – 3DVector Structure

Name

Type

Description

3DVector

Structure

X

Double

Length of X direction

Y

Double

Length of Y direction

Z

Double

Length of Z direction

Its representation in the AddressSpace is defined in Table 259.

Table 259 – 3DVector definition

Attributes

Value

BrowseName

3DVector

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Vector DataType defined in Table 257.

Conformance Units

Base Info Spatial Data

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 260.

Table 260 – CartesianCoordinates Structure

Name

Type

Description

CartesianCoordinates

Structure

Its representation in the AddressSpace is defined in Table 261.

Table 261 – CartesianCoordinates definition

Attributes

Value

BrowseName

CartesianCoordinates

IsAbstract

TRUE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info Spatial Data

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 262.

Table 262 – 3DCartesianCoordinates Structure

Name

Type

Description

3DCartesianCoordinates

Structure

X

Double

X coordinate

Y

Double

Y coordinate

Z

Double

Z coordinate

Its representation in the AddressSpace is defined in Table 263.

Table 263 – 3DCartesianCoordinates definition

Attributes

Value

BrowseName

3DCartesianCoordinates

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the CartesianCoordinates DataType defined in Table 261.

Conformance Units

Base Info Spatial Data

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 264.

Table 264 – Orientation Structure

Name

Type

Description

Orientation

Structure

Its representation in the AddressSpace is defined Table 265.

Table 265 – Orientation definition

Attributes

Value

BrowseName

Orientation

IsAbstract

TRUE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info Spatial Data

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

Table 266 – 3DOrientation Structure

Name

Type

Description

3DOrientation

Structure

A

Double

Rotation around A dimension

B

Double

Rotation around B dimension

C

Double

Rotation around C dimension

Its representation in the AddressSpace is defined Table 267.

Table 267 – 3DOrientation definition

Attributes

Value

BrowseName

3DOrientation

Abstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Orientation DataType defined in Table 265.

Conformance Units

Base Info Spatial Data

This abstract Structured DataType is the base to define multi-dimensional frames. There are no specific elements defined as shown in Table 268. 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 268 – Frame Structure

Name

Type

Description

Frame

Structure

Its representation in the AddressSpace is defined Table 269.

Table 269 – Frame definition

Attributes

Value

BrowseName

Frame

IsAbstract

TRUE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Structure DataType defined in Table 185.

Conformance Units

Base Info Spatial Data

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 270.

Table 270 – 3DFrame Structure

Name

Type

Description

3DFrame

Structure

CartesianCoordinates

3DCartesianCoordinates

Cartesian coordinates of the frame in 3D space.

Orientation

3DOrientation

Orientation of the frame in 3D space.

Its representation in the AddressSpace is defined Table 271.

Table 271 – 3DFrame definition

Attributes

Value

BrowseName

3DFrame

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Frame DataType defined in Table 269.

Conformance Units

Base Info Spatial Data

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 272.

Table 272 – DataTypeSchemaHeader structure

Name

Type

Description

DataTypeSchemaHeader

Structure

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 273.

Table 273 – DataTypeSchemaHeader definition

Attributes

Value

BrowseName

DataTypeSchemaHeader

IsAbstract

TRUE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of Structure defined in Table 185.

Conformance Units

Base Info UaBinary File

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 274.

Table 274 – DataTypeDescription structure

Name

Type

Description

DataTypeDescription

Structure

dataTypeId

NodeId

The NodeId of the DataType.

name

QualifiedName

A unique name for the data type.

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

Table 275 – DataTypeDescription definition

Attributes

Value

BrowseName

DataTypeDescription

IsAbstract

TRUE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of Structure defined in Table 185.

Conformance Units

Base Info UaBinary File

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 276.

Table 276 – StructureDescription structure

Name

Type

Description

StructureDescription

Structure

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 277.

Table 277 – StructureDescription definition

Attributes

Value

BrowseName

StructureDescription

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of DataTypeDescription defined in 12.32.

Conformance Units

Base Info UaBinary File

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 278.

Table 278 – EnumDescription structure

Name

Type

Description

EnumDescription

Structure

enumDefinition

EnumDefinition

The definition of the enumeration DataType.

The EnumDefinition DataType is defined in OPC 10000-3.

builtInType

Byte

The 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 279.

Table 279 – EnumDescription definition

Attributes

Value

BrowseName

EnumDescription

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of DataTypeDescription defined in 12.32.

Conformance Units

Base Info UaBinary File

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 280.

Table 280 – SimpleTypeDescription structure

Name

Type

Description

SimpleTypeDescription

Structure

baseDataType

NodeId

The base DataType of the simple DataType.

builtInType

Byte

The builtInType used for the encoding of the simple DataType.

Its representation in the AddressSpace is defined in Table 281.

Table 281 – SimpleTypeDescription definition

Attributes

Value

BrowseName

SimpleTypeDescription

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of DataTypeDescription defined in 12.32.

Conformance Units

Base Info UaBinary File

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 282.

Table 282 – UABinaryFileDataType structure

Name

Type

Description

UABinaryFileDataType

Structure

Subtype 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 283.

Table 283 – UABinaryFileDataType definition

Attributes

Value

BrowseName

UABinaryFileDataType

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of DataTypeSchemaHeader defined in 12.31.

Conformance Units

Base Info UaBinary File

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

Table 284 – PortableQualifiedName Structure

Name

Type

Description

PortableQualifiedName

structure

namespaceUri

String

The namespace URI portion of the QualifiedName.

name

String

The text portion of the QualifiedName.

Its representation in the AddressSpace is defined in Table 285.

Table 285 – PortableQualifiedName definition

Attributes

Value

BrowseName

PortableQualifiedName

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of Structure defined in Table 185.

Conformance Units

Base Info Portable IDs

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

Table 286 – PortableNodeId Structure

Name

Type

Description

PortableNodeId

structure

namespaceUri

String

The namespace URI portion of the NodeId.

identifier

NodeId

The 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 287.

Table 287 – PortableNodeId definition

Attributes

Value

BrowseName

PortableNodeId

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of Structure defined in Table 185.

Conformance Units

Base Info Portable IDs

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 288.

Table 288 – UriString definition

Attributes

Value

BrowseName

UriString

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of String defined in Table 178.

Conformance Units

Base Info UriString

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 289.

Table 289 – UnsignedRationalNumber structure

Name

Type

Description

UnsignedRationalNumber

Structure

Numerator

UInt32

Numerator of the rational number

Denominator

UInt32

Denominator of the rational number

Its representation in the AddressSpace is defined in Table 290.

Table 290 – UnsignedRationalNumber definition

Attributes

Value

BrowseName

UnsignedRationalNumber

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of Structure defined in Table 185.

Conformance Units

Base Info Rational Number

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

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

Table 291 – SemanticVersionString definition

Attributes

Value

BrowseName

SemanticVersionString

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the String DataType defined in Table 178.

Conformance Units

Base Info SemanticVersionString

Table 292 – 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"

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 293.

Table 293 – Handle definition

Attributes

Value

BrowseName

Handle

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the UInt32 DataType defined in Table 175.

Conformance Units

Base Info Handle DataType

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 293.

Table 294 – TrimmedString definition

Attributes

Value

BrowseName

TrimmedString

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the String DataType defined in Table 178.

Conformance Units

Base Info TrimmedString

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

Table 295 – RedundantServerMode values

Name

Value

Description

PRIMARY_WITH_BACKUP

0

The 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_ONLY

1

The Server is acting as the primary in a non-transparent backup Server Set however no other Server are available to take over

BACKUP_READY

2

The Server is acting as a backup to the primary and is ready to take over as the primary

BACKUP_NOT_READY

3

The 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 296.

Table 296 – RedundantServerMode definition

Attributes

Value

BrowseName

RedundantServerMode

IsAbstract

FALSE

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

Subtype of the Enumeration DataType defined in Table 154.

HasProperty

Variable

EnumStrings

LocalizedText[]

PropertyType

Conformance Units

Base Info ServerType

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

Table 297 – BitFieldDefinition Structure

Name

Type

Description

BitFieldDefinition

Structure

Name

String

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

Description

LocalizedText

A localized description of the field.

Reserved

Boolean

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

StartingBitPosition

UInt32

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

EndingBitPosition

UInt32

The 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 298.

Table 298 – BitFieldDefinition definition

Attributes

Value

BrowseName

BitFieldDefinition

IsAbstract

FALSE

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 299 and Table 300, 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 301 and Table 302. The three bits which are not defined can be utilized by SubTypes defined in any Namespace.

Table 299 – MyBitFieldType VariableType Example

Attribute

Value

BrowseName

MyBitFieldType

IsAbstract

False

ValueRank

−1 (−1 = Scalar)

DataType

UInt16

References

NodeClass

BrowseName

DataType

TypeDefinition

MR

Subtype of the BitFieldType defined in 7.29

HasProperty

Variable

MyBitFieldDefinitions

BitFieldDefinition[]

PropertyType

M

HasComponent

Variable

Counter

Int16

BaseDataVariableType

M

HasComponent

Variable

Enabled

Boolean

BaseDataVariableType

M

HasComponent

Variable

Status

Boolean

BaseDataVariableType

M

Table 300 – MyBitFieldDefinitions BitFieldDefinition Example

Name

Description

Reserved

StartingBit

Position

EndingBitPosition

Counter

A 6-bit counter representing a signed integer value. As a signed integer the 6th bit (position 5) is the sign bit.

N

0

5

MyReservedBit

A single bit reserved for future extension

Y

6

6

Enabled

A single bit representing a Boolean enable value

N

7

7

Status

A single bit representing a Boolean status value

N

8

8

MyReserveBlock

A range of 4 reserved bits for future extension

Y

12

15

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

image014.png

Figure 11 – MyBitFieldType Example Illustration

Table 301 – MyBitFieldSubType VariableType Example

Attribute

Value

BrowseName

MyBitFieldSubType

IsAbstract

False

ValueRank

−1 (−1 = Scalar)

DataType

UInt16

References

NodeClass

BrowseName

DataType

TypeDefinition

MR

Subtype of the MyBitFieldType defined in Table 299

HasProperty

Variable

MyBitFieldSubDefinitions

BitFieldDefinition[]

PropertyType

M

HasComponent

Variable

SubStatus

Boolean

BaseDataVariableType

M

Table 302 – MyBitFieldSubDefinitions BitFieldDefinition Example

Name

Description

Reserved

StartingBit

Position

EndingBitPosition

Counter

A 6-bit counter representing a signed integer value. As a signed integer the 6th bit (position 5) is the sign bit.

N

0

5

SubStatus

A single bit representing a Boolean substatus. This field is utilizing the MyReservedBit reserved bit defined in the parent Type

N

6

6

Enabled

A single bit representing a Boolean enable value

N

7

7

Status

A single bit representing a Boolean status value

N

8

8

MyReserveBlock

A range of 4 reserved bits for future extension

Y

12

15

The following is another BitFieldType VariableType example intended to illustrate the use of an Array DataType. In this example the MyBitFieldArrayType, defined in Table 303 and Table 304, 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 303 – MyBitFieldArrayType VariableType Example

Attribute

Value

BrowseName

MyBitFieldArrayType

IsAbstract

False

ValueRank

1 (1 = Array)

DataType

UInt16[]

References

NodeClass

BrowseName

DataType

TypeDefinition

MR

Subtype of the BitFieldType defined in defined 7.29

HasProperty

Variable

MyBitFieldArrayDefinitions

BitFieldDefinition[]

PropertyType

M

HasComponent

Variable

Counter

Int32

BaseDataVariableType

M

HasComponent

Variable

Enabled

Boolean

BaseDataVariableType

M

Table 304 – MyBitFieldArrayDefinitions BitFieldDefinition Example

Name

Description

Reserved

StartingBit

Position

EndingBitPosition

Counter

A 24-bit counter representing a signed integer value. As a signed integer the 24th bit (position 23) is the sign bit.

N

0

23

MyReservedBit

A single bit reserved for future extension

Y

24

24

Enabled

A single bit representing a Boolean enable value

N

25

25

image015.png

Figure 12 – MyBitFieldArrayType Example Illustration