The WriterGroupId with DataType UInt16 is an identifier for the WriterGroup and shall be unique across all WriterGroups for a PublisherId. All values, except for 0, are valid. The value 0 is defined as null value.
The PublishingInterval with the DataType Duration defines the interval in milliseconds for publishing NetworkMessages and the embedded DataSetMessages created by the related DataSetWriters.
In the case of Event based DataSets, this may result in zero to many DataSetMessages produced for one PublishedDataSet in a PublishingInterval. All Events that occur between two PublishingIntervals shall be buffered until the next NetworkMessage is sent. If the number of Events exceeds the buffer capability of the DataSetWriter, an Event of type EventQueueOverflowEventType is inserted into the buffer.
The Duration DataType is a subtype of Double and allows configuration of intervals smaller than a millisecond.
The KeepAliveTime with DataType Duration defines the time in milliseconds until the Publisher sends a keep alive DataSetMessage in the case where no DataSetMessage was sent in this period by a DataSetWriter. The minimum value shall equal the PublishingInterval.
The Priority with DataType Byte defines the relative priority of the WriterGroup to all other WriterGroups across all PubSubConnections of the Publisher.
If more than one WriterGroup needs to be processed, the priority number defines the order of processing. The highest priority is processed first.
The lowest priority is zero and the highest is 255.
The LocaleIds with DataType LocaleId defines a list of locale ids in priority order for localized strings for all DataSetWriters in the WriterGroup. The first LocaleId in the list has the highest priority.
If the Publisher sends a localized String, the Publisher shall send the translation with the highest priority that it can. If it does not have a translation for any of the locales identified in this list, then it shall send the String value that it has and include the LocaleId with the String. If no locale id is configured, the Publisher shall use any that it has. See Part 3 for more detail on LocaleId.
This Structure DataType is used to represent the configuration parameters for WriterGroups. It is a subtype of PubSubGroupDataType defined in 0.
The WriterGroupDataType is formally defined in Table 22.
Table 22 – WriterGroupDataType Structure
|writerGroupId||UInt16||Defined in 188.8.131.52.|
|publishingInterval||Duration||Defined in 184.108.40.206.|
|keepAliveTime||Duration||Defined in 220.127.116.11.|
|priority||Byte||Defined in 18.104.22.168.|
|localeIds||LocaleId||Defined in 22.214.171.124.|
|headerLayoutUri||String||Defined in 126.96.36.199.|
|transportSettings||WriterGroupTransportDataType||Transport mapping specific WriterGroup parameters. The abstract base type is defined in 188.8.131.52.2. The concrete subtypes are defined in the sections for transport mapping specific parameters.|
|messageSettings||WriterGroupMessageDataType||NetworkMessage mapping specific WriterGroup parameters. The abstract base type is defined in 184.108.40.206.3. The concrete subtypes are defined in the sections for message mapping specific parameters.|
|dataSetWriters||DataSetWriterDataType||The DataSetWriters contained in the WriterGroup. The DataSetWriter parameters are defined in 6.2.3.|
The WriterGroupDataType Structure representation in the AddressSpace is defined in Table 23.
Table 23 – WriterGroupDataType Definition
|Subtype of PubSubGroupDataType defined in 0.|
This Structure DataType is an abstract base type for transport mapping specific WriterGroup parameters. The abstract DataType does not define fields.
The WriterGroupTransportDataType Structure representation in the AddressSpace is defined in Table 24.
Table 24 – WriterGroupTransportDataType Definition
|Subtype of Structure defined in Part 5.|
|HasSubtype||DataType||DatagramWriterGroupTransportDataType||FALSE||Defined in 220.127.116.11.3.|
|HasSubtype||DataType||BrokerWriterGroupTransportDataType||FALSE||Defined in 18.104.22.168.6.|
This Structure DataType is an abstract base type for message mapping specific WriterGroup parameters. The abstract DataType does not define fields.
The WriterGroupMessageDataType Structure representation in the AddressSpace is defined in Table 25.
Table 25 – WriterGroupMessageDataType Structure
|Subtype of Structure defined in Part 5.|
|HasSubtype||DataType||UadpWriterGroupMessageDataType||FALSE||Defined in 22.214.171.124.7.|
|HasSubtype||DataType||JsonWriterGroupMessageDataType||FALSE||Defined in 126.96.36.199.2.|