UAJsonDataSetMessageContentMask Enumeration

JSON message mapping specific flags for content of the dataset message header.

Syntax

Visual Basic
C#
C++/CLI

'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

Member	Value	Description
DataSetWriterId	1	If 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.
DataSetWriterName	64	If 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. https://mantis.opcfoundation.org/view.php?id=7328 0007328: JSON Data Set MessageHeader needs a DataSetWriterName Field
MessageType	32	If 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. https://mantis.opcfoundation.org/view.php?id=5372 0005372: Keep-alive message in JSON unclear or unfeasible
MetaDataVersion	2	If 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.
None	0	"No flags.
PublisherId	256	The PublisherId is included in the DataSetMessages. Remarks: This flag was added in OPC UA specification version 1.05.3.
ReversibleFieldEncoding	128	If 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. https://mantis.opcfoundation.org/view.php?id=7038 0007038: PubSub JSON encoding for DataSetMessage needs reversible encoding for DataValue
SequenceNumber	4	If 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.
Status	16	If 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.
Timestamp	8	If 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.
WriterGroupName	512	The WriterGroup name is included in the DataSetMessages. Remarks: This flag was added in OPC UA specification version 1.05.3.

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

Reference

OpcLabs.EasyOpc.UA.PubSub.Configuration Namespace

Send Documentation Feedback. Resources: Knowledge Base. Technical support: Online Forums, FAQ.