The parameter GroupVersion with DataType VersionTime defines the expected value in the field GroupVersion in the header of the NetworkMessage. The default value 0 is defined as null value, and means this parameter shall be ignored.
The parameter NetworkMessageNumber with DataType UInt16 is the number of the NetworkMessage inside a PublishingInterval in which this DataSetMessage is published. The default value 0 is defined as null value, and means this parameter shall be ignored.
The NetworkMessage shall have a fixed layout if the PayloadHeader flag in the NetworkMessageContentMask is false.
The parameter DataSetOffset with DataType UInt16 defines the offset in bytes for the DataSetMessage inside the corresponding NetworkMessage relative to the beginning of the NetworkMessage. The default value 0 is defined as null value, and means that the position of the DataSetMessage in a NetworkMessage is not fixed.
This parameter should be set if the PayloadHeader flag in the NetworkMessageContentMask is false and therefore the NetworkMessage has a fixed layout.
The parameter DataSetClassId with DataType Guid defines a DataSet class related filter. If the value is null, the DataSetClassId filter is not applied.
The NetworkMessageContentMask with DataType UadpNetworkMessageContentMask indicates the optional header fields included in the received NetworkMessages.
The UadpNetworkMessageContentMask DataType is defined in 6.3.1.1.4.
The DataSetMessageContentMask with the DataType UadpDataSetMessageContentMask indicates the optional header fields included in the DataSetMessages.
The UadpDataSetMessageContentMask DataType is defined in 6.3.1.3.2.
The PublishingInterval with DataType Duration indicates the rate the Publisher sends NetworkMessages related to the DataSet. The start time for the periodic execution of the Subscriber shall be calculated according to 6.3.1.1.1.
The ReceiveOffset with DataType Duration defines the time in milliseconds for the offset in the PublishingInterval cycle for the expected receive time of the NetworkMessage for the DataSet from the network.
Any negative value indicates that the ReceiveOffset is not configured and the timing inside the PublishingInterval is not defined.
The ProcessingOffset with DataType Duration defines the time in milliseconds for the offset in the PublishingInterval cycle when the received DataSet need to be processed by the application in the Subscriber.
The different timing offsets inside a PublishingInterval cycle on the Publisher and Subscriber sides are shown in Figure 26.
Any negative value indicates that the ProcessingOffset is not configured and the timing inside the PublishingInterval is application specific.
This Structure DataType is used to represent UADP message mapping specific DataSetReader parameters. It is a subtype of the DataSetReaderMessageDataType defined in 6.2.9.13.3.
The UadpDataSetReaderMessageDataType is formally defined in Table 91.
Table 91 – UadpDataSetReaderMessageDataType structure
Name |
Type |
Description |
UadpDataSetReaderMessageDataType |
Structure |
Subtype of DataSetReaderMessageDataType defined in 6.2.9.13.3. |
GroupVersion |
VersionTime |
Defined in 6.3.1.4.1. |
NetworkMessageNumber |
UInt16 |
Defined in 6.3.1.4.2. |
DataSetOffset |
UInt16 |
Defined in 6.3.1.4.3. |
DataSetClassId |
Guid |
Defined in 6.3.1.4.4. |
NetworkMessageContentMask |
UadpNetworkMessageContentMask |
Defined in 6.3.1.4.5. |
DataSetMessageContentMask |
UadpDataSetMessageContentMask |
Defined in 6.3.1.4.6. |
PublishingInterval |
Duration |
Defined in 6.3.1.4.7. |
ReceiveOffset |
Duration |
Defined in 6.3.1.4.8. |
ProcessingOffset |
Duration |
Defined in 6.3.1.4.9. |
Its representation in the AddressSpace is defined in Table 92.
Table 92 – UadpDataSetReaderMessageDataType definition
Attributes |
Value |
BrowseName |
UadpDataSetReaderMessageDataType |
IsAbstract |
False |
Subtype of DataSetReaderMessageDataType defined in 6.2.9.13.3. |
|
Conformance Units |
|
PubSub Parameters UADP |