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. The value of this enum member is 1.
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. 0007328: JSON Data Set MessageHeader needs a DataSetWriterName Field The value of this enum member is 64.
FieldEncoding1	128	Defines 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. The value of this enum member is 128.
FieldEncoding2	2048	Defines field encoding configuration, together with FieldEncoding1. Remarks: This flag was added in OPC UA specification version 1.05.04. The value of this enum member is 2048.
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. 0005372: Keep-alive message in JSON unclear or unfeasible The value of this enum member is 32.
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. The value of this enum member is 2.
MinorVersion	1024	The 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. The value of this enum member is 1024.
None	0	"No flags. The value of this enum member is 0.
PublisherId	256	The Publisher Id is included in the dataset messages. Remarks: This flag was added in OPC UA specification version 1.05.03. This bit shall be false if the NetworkMessageHeader is active. The value of this enum member is 256.
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. 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. The value of this enum member is 128.
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. The value of this enum member is 4.
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. The value of this enum member is 16.
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. The value of this enum member is 8.
WriterGroupName	512	The writer group name is included in the dataset messages. Remarks: This flag was added in OPC UA specification version 1.05.03. If the writer group name is included in the network message header, it shall not be included in the dataset messages. The value of this enum member is 512.

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

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

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.