OPC Studio User's Guide and Reference
UAJsonDataSetMessageContentMask Enumeration



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.PubSub.Configuration Namespace : UAJsonDataSetMessageContentMask Enumeration
JSON message mapping specific flags for content of the dataset message header.
Syntax
'Declaration
 
<ComVisibleAttribute(True)>
<DisplayName2Attribute("OPC UA JSON DataSet Message Content Mask")>
<FlagsAttribute()>
<GuidAttribute("60463078-B04A-4B20-8B50-1A438B11D573")>
Public Enum UAJsonDataSetMessageContentMask 
   Inherits System.Enum
   Implements System.IComparable, System.IConvertible, System.IFormattable 
'Usage
 
Dim instance As UAJsonDataSetMessageContentMask
[ComVisible(true)]
[DisplayName2("OPC UA JSON DataSet Message Content Mask")]
[Flags()]
[Guid("60463078-B04A-4B20-8B50-1A438B11D573")]
public enum UAJsonDataSetMessageContentMask : System.Enum, System.IComparable, System.IConvertible, System.IFormattable  
[ComVisible(true)]
[DisplayName2("OPC UA JSON DataSet Message Content Mask")]
[Flags()]
[Guid("60463078-B04A-4B20-8B50-1A438B11D573")]
public enum class UAJsonDataSetMessageContentMask : public System.Enum, System.IComparable, System.IConvertible, System.IFormattable  
Members
MemberValueDescription
DataSetWriterId1If this flag is set, a dataset writer Id shall be included in the dataset message header.

Remarks:

In OPC UA specification version 1.04, Part 14 Table 62 appears to have bits incorrectly numbered from 1 instead of 0.

OPC UA specification version 1.04 prescribed that DataSetWriterId is formatted as a String. Errata 1.04.2 changes the format to UInt16.

DataSetWriterName64If this flag is set, a DataSetWriterName shall be included in the DataSetMessage header.

Remarks:

This flag was added in OPC UA specification version 1.05.01. 0007328: JSON Data Set MessageHeader needs a DataSetWriterName Field

FieldEncoding1128Defines field encoding configuration, together with FieldEncoding2.

Remarks:

This flag was first defined in OPC UA specification version 1.05.04, by renaming and partially repurposing the ReversibleFieldEncoding flag.

FieldEncoding22048Defines field encoding configuration, together with FieldEncoding1.

Remarks:

This flag was added in OPC UA specification version 1.05.04.

MessageType32If this flag is set, the message type is included in the dataset message header.

Remarks:

This flag was added in OPC UA specification version 1.04.10 Errata. 0005372: Keep-alive message in JSON unclear or unfeasible

MetaDataVersion2If this flag is set, the configuration version is included in the dataset message header.

Remarks:

In OPC UA specification version 1.04, Part 14 Table 62 appears to have bits incorrectly numbered from 1 instead of 0.

MinorVersion1024The MinorVersion field of the configuration version is included in the DataSetMessage header.

Remarks:

This flag was added in OPC UA specification version 1.05.03.

None0"No flags.
PublisherId256The Publisher Id is included in the dataset messages.

Remarks:

This flag was added in OPC UA specification version 1.05.03.

ReversibleFieldEncoding128If this flag is set, the DataSetMessage fields are encoded in the reversible JSON encoding and in the non-reversible JSON encoding otherwise.

Remarks:

This flag was added in OPC UA specification version 1.05.01. 0007038: PubSub JSON encoding for DataSetMessage needs reversible encoding for DataValue

This flag bit has been partially repurposed, and renamed to FieldEncoding1 in OPC UA specification version 1.05.04.

SequenceNumber4If this flag is set, the dataset message sequence number is included in the dataset message header.

Remarks:

In OPC UA specification version 1.04, Part 14 Table 62 appears to have bits incorrectly numbered from 1 instead of 0.

Status16If this flag is set, an overall status is included in the dataset message header.

Remarks:

In OPC UA specification version 1.04, Part 14 Table 62 appears to have bits incorrectly numbered from 1 instead of 0.

Timestamp8If this flag is set, a timestamp shall be included in the dataset message header.

Remarks:

In OPC UA specification version 1.04, Part 14 Table 62 appears to have bits incorrectly numbered from 1 instead of 0.

WriterGroupName512The writer group name is included in the dataset messages.

Remarks:

This flag was added in OPC UA specification version 1.05.03.

Remarks

In OPC UA specification version 1.04, Part 14 Table 62 appears to have bits incorrectly numbered from 1 instead of 0.

Inheritance Hierarchy

System.Object
   System.ValueType
      System.Enum
         OpcLabs.EasyOpc.UA.PubSub.Configuration.UAJsonDataSetMessageContentMask

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also