6 PubSub Communication Parameters ToC Previous Next

6.3 Message Mapping Configuration Parameters ToC Previous Next

6.3.2 JSON Message Mapping ToC Previous Next

6.3.2.1 JSON NetworkMessage Writer ToC

6.3.2.1.1 NetworkMessageContentMask ToC

The parameter NetworkMessageContentMask defines the optional header fields to be included in the NetworkMessages produced by the WriterGroup. The DataType for the JSON NetworkMessage mapping is JsonNetworkMessageContentMask.

The DataType JsonNetworkMessageContentMask is formally defined in Table 59.

Table 59 – JsonNetworkMessageContentMask Values

Value Bit No. Description
NetworkMessageHeader 0 The JSON NetworkMessage header is included in the NetworkMessages.If this bit is false, bits 2 to 4 shall be 0.
DataSetMessageHeader 1 The JSON DataSetMessage header is included in each DataSetMessage.If this bit is false then the DataSetMessageContentMask for the DataSetWriters are ignored (see 6.3.2.2.1).
SingleDataSetMessage 2 Each JSON NetworkMessage contains only one DataSetMessage.
PublisherId 3 The PublisherId is included in the NetworkMessages.
DataSetClassId 4 The DataSetClassId is included in the NetworkMessages.
ReplyTo 5 The ReplyTo is included in the NetworkMessages.

The JsonNetworkMessageContentMask representation in the AddressSpace is defined in Table 60.

Table 60 – JsonNetworkMessageContentMask Definition

Attributes Value    
BrowseName JsonNetworkMessageContentMask    
IsAbstract False    
References NodeClass BrowseName DataType
Subtype of UInt32 defined in Part 5.      
HasProperty Variable OptionSetValues LocalizedText [ ]

6.3.2.1.2 JsonWriterGroupMessageDataType Structure ToC Model

This Structure DataType is used to represent the JSON NetworkMessage mapping specific WriterGroup parameters. It is a subtype of WriterGroupMessageDataType defined in 6.2.5.6.3.

The JsonWriterGroupMessageDataType is formally defined in Table 61.

Table 61 – JsonWriterGroupMessageDataType Structure

Name Type Description
JsonWriterGroupMessageDataType Structure  
 networkMessageContentMask JsonNetworkMessageContentMask Defined in 6.3.2.1.1.

6.3.2.2 JSON DataSetMessage Writer ToC

6.3.2.2.1 DataSetMessageContentMask ToC

The DataSetMessageContentMask defines the flags for the content of the DataSetMessage header. The JSON message mapping specific flags are defined by the JsonDataSetMessageContentMask DataType.

The JsonDataSetMessageContentMask DataType is formally defined in Table 62.

Table 62 – JsonDataSetMessageContentMask Values

Value Bit No. Description
DataSetWriterId 0 If this flag is set, a DataSetWriterId shall be included in the DataSetMessage header.
MetaDataVersion 1 If this flag is set, the ConfigurationVersion is included in the DataSetMessage header.
SequenceNumber 2 If this flag is set, the DataSetMessageSequenceNumber is included in the DataSetMessage header.
Timestamp 3 If this flag is set, a timestamp shall be included in the DataSetMessage header.
Status 4 If this flag is set, an overall status is included in the DataSetMessage header.

The JsonDataSetMessageContentMask representation in the AddressSpace is defined in Table 63.

Table 63 – JsonDataSetMessageContentMask Definition

Attributes Value    
BrowseName JsonDataSetMessageContentMask    
IsAbstract False    
References NodeClass BrowseName DataType
Subtype of UInt32 defined in Part 5.      
HasProperty Variable OptionSetValues LocalizedText [ ]

6.3.2.2.2 JsonDataSetWriterMessageDataType Structure ToC Model

This Structure DataType is used to represent JSON DataSetMessage mapping specific DataSetWriter parameters. It is a subtype of the DataSetWriterMessageDataType defined in 6.2.3.5.3.

The JsonDataSetWriterMessageDataType is formally defined in Table 64.

Table 64 – JsonDataSetWriterMessageDataType Structure

Name Type Description
JsonDataSetWriterMessageDataType Structure  
 dataSetMessageContentMask JsonDataSetMessageContentMask Defined in 6.3.2.2.1.

6.3.2.3 JSON DataSetMessage Reader ToC Model

6.3.2.3.1 NetworkMessageContentMask ToC Model

The NetworkMessageContentMask with DataType JsonNetworkMessageContentMask indicates the optional header fields included in the received NetworkMessages. The JsonNetworkMessageContentMask DataType is defined in 6.3.2.1.1.

6.3.2.3.2 DataSetMessageContentMask ToC Model

The DataSetMessageContentMask with the DataType JsonDataSetMessageContentMask indicates the optional header fields included in the DataSetMessages.

The JsonDataSetMessageContentMask DataType is defined in 6.3.2.2.1.

6.3.2.3.3 JsonDataSetReaderMessageDataType Structure ToC Model

This Structure DataType is used to represent JSON DataSetMessage mapping specific DataSetReader parameters. It is a subtype of the DataSetReaderMessageDataType defined in 6.2.8.11.3.

The JsonDataSetReaderMessageDataType is formally defined in Table 65.

Table 65 – JsonDataSetReaderMessageDataType Structure

Name Type Description
JsonDataSetReaderMessageDataType Structure  
 networkMessageContentMask JsonNetworkMessageContentMask Defined in 6.3.2.3.1.
 dataSetMessageContentMask JsonDataSetMessageContentMask Defined in 6.3.2.3.2.

Previous Next