Class RelativeSpeedToMaster (SynchronizeAction) - inconsistency in value units
Document Version of this comment:
- Branch: master
Problem description
- The
Class RelativeSpeedToMaster
enclosed in theClass SynchronizeAction
contains the "speedTargetValueType" property which defines semantics and therefore units for the "value" property (to be either "m/s" or "no units") dependent on "delta" or "factor" is chosen.
However, the "value" property description defines only "m/s" units for all cases that is incorrect. - The "speedTargetValueType" property description mentions the "offset" as a possible choice. In fact, no "offset" is defined in the XSD. There are only "delta" (for m/s) and "factor" (for "no units").
Proposal for improvements
- Correct the description of the "value" property.
Old content 1
Relative speed. Unit: m/s. Range: ]-inf..inf[.
New content 1
Relative speed. Units are defined by the semantics of the "speedTargetValueType" property:
- for "delta": Unit: m/s. Range: ]-inf..inf[.
- for "factor": Unit: no unit. Range: ]0..inf[.
- Correct the description of the "speedTargetValueType" property.
Old content 2
The semantics of the value (delta, offset, factor).
New content 2
The semantics of the value (delta, factor).
Backward compatibility
Compatible as no changes in the XSD schema. Only the description is refined.