Skip to content

Commit 6fd1bec

Browse files
pmaipmai
committed
Refer to OpenDRIVE, clarify deprecation intent
Signed-off-by: Pierre R. Mai <pmai@pmsf.de>
1 parent df50fbb commit 6fd1bec

File tree

2 files changed

+182
-67
lines changed

2 files changed

+182
-67
lines changed

‎osi_roadmarking.proto‎

Lines changed: 74 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,12 @@ message RoadMarking
7373
// \note Field need not be set (or set to \c #TYPE_OTHER)
7474
// if road marking type (\c #type) does not require it.
7575
//
76+
// \attention Deprecated: A revision is planned for version 4.0.0 to
77+
// replace the type enum with a more semantically defined enumeration,
78+
// with the exact sign specification being relegated to the newly
79+
// introduced 4-tupel traffic sign catalog specification as used in
80+
// <a href="https://releases.asam.net/OpenDRIVE/1.6.0/ASAM_OpenDRIVE_BS_V1-6-0.html#_signals">OpenDRIVE</a>.
81+
//
7682
// \rules
7783
// check_if this.type is_greater_than_or_equal_to 2 else do_check is_set
7884
// check_if this.type is_less_than_or_equal_to 4 else do_check is_set
@@ -119,7 +125,6 @@ message RoadMarking
119125
//
120126
repeated Identifier assigned_lane_id = 6;
121127

122-
123128
// Boolean flag to indicate that the road marking is taken out of service.
124129
// This can be achieved by visibly crossing the road marking with stripes,
125130
// or completely covering a road marking making it not visible.
@@ -128,36 +133,92 @@ message RoadMarking
128133
//
129134
optional bool is_out_of_service = 7;
130135

131-
// Specifies the country. See ISO 3166-1, alpha-2 codes
132-
// https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. <br>
133-
// e.g. "DE", "FR", "AT"
136+
// Country specification of the traffic sign catalog specification
137+
// that identifies the actual traffic sign. This is part of the
138+
// 4-tupel traffic sign catalog specification as used in
139+
// <a href="https://releases.asam.net/OpenDRIVE/1.6.0/ASAM_OpenDRIVE_BS_V1-6-0.html#_signals">OpenDRIVE</a>.
140+
//
141+
// Country is specified using the ISO 3166-1, alpha-2 code
142+
// https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2, or the
143+
// special OpenDRIVE country for generic signs.<br>
144+
//
145+
// \rules
146+
// check_if this.type is_greater_than_or_equal_to 2 else do_check is_set
147+
// check_if this.type is_less_than_or_equal_to 4 else do_check is_set
148+
// \endrules
134149
//
135150
optional string country = 8;
136151

137-
// The year the traffic rules come into force. <br>
152+
// Revision specification of the traffic sign catalog specification
153+
// that identifies the actual traffic sign. This is part of the
154+
// 4-tupel traffic sign catalog specification as used in
155+
// <a href="https://releases.asam.net/OpenDRIVE/1.6.0/ASAM_OpenDRIVE_BS_V1-6-0.html#_signals">OpenDRIVE</a>.
156+
//
157+
// The year the traffic rules came into force. <br>
138158
// e.g. "2017"
139159
//
160+
// \note Field is set if ( \c #type == \c #TYPE_PAINTED_TRAFFIC_SIGN or
161+
// \c #TYPE_SYMBOLIC_TRAFFIC_SIGN or \c #TYPE_TEXTUAL_TRAFFIC_SIGN ).
162+
//
163+
// \note Field need not be set (or set to \c #TYPE_OTHER)
164+
// if road marking type (\c #type) does not require it.
165+
//
166+
// \rules
167+
// check_if this.type is_greater_than_or_equal_to 2 else do_check is_set
168+
// check_if this.type is_less_than_or_equal_to 4 else do_check is_set
169+
// \endrules
170+
//
140171
optional string country_revision = 9;
141172

142-
// Code identifier according to country code. <br>
173+
// Code specification of the traffic sign catalog specification
174+
// that identifies the actual traffic sign. This is part of the
175+
// 4-tupel traffic sign catalog specification as used in
176+
// <a href="https://releases.asam.net/OpenDRIVE/1.6.0/ASAM_OpenDRIVE_BS_V1-6-0.html#_signals">OpenDRIVE</a>.
177+
//
178+
// Code identifier according to country and country revision,
179+
// corresponds to the type field of OpenDRIVE. <br>
143180
// code is only unique in combination with #country and #country_revision. <br>
144181
// e.g. http://www.vzkat.de/2017/VzKat.htm
145182
//
183+
// \note Field is set if ( \c #type == \c #TYPE_PAINTED_TRAFFIC_SIGN or
184+
// \c #TYPE_SYMBOLIC_TRAFFIC_SIGN or \c #TYPE_TEXTUAL_TRAFFIC_SIGN ).
185+
//
186+
// \note Field need not be set (or set to \c #TYPE_OTHER)
187+
// if road marking type (\c #type) does not require it.
188+
//
189+
// \rules
190+
// check_if this.type is_greater_than_or_equal_to 2 else do_check is_set
191+
// check_if this.type is_less_than_or_equal_to 4 else do_check is_set
192+
// \endrules
193+
//
146194
optional string code = 10;
147195

148-
// Subcode identifier according to country code. <br>
149-
// sub_code is only unique in combination with #country and #country_revision. <br>
196+
// Sub-code specification of the traffic sign catalog specification
197+
// that identifies the actual traffic sign. This is part of the
198+
// 4-tupel traffic sign catalog specification as used in
199+
// <a href="https://releases.asam.net/OpenDRIVE/1.6.0/ASAM_OpenDRIVE_BS_V1-6-0.html#_signals">OpenDRIVE</a>.
200+
//
201+
// Sub-code identifier according to country, country revision and code,
202+
// corresponds to the subtype field of OpenDRIVE. <br>
203+
// sub_code is only unique in combination with #country, #country_revision,
204+
// and #code. <br>
150205
// e.g. http://www.vzkat.de/2017/VzKat.htm
151206
//
207+
// \note Field is set if ( \c #type == \c #TYPE_PAINTED_TRAFFIC_SIGN or
208+
// \c #TYPE_SYMBOLIC_TRAFFIC_SIGN or \c #TYPE_TEXTUAL_TRAFFIC_SIGN ).
209+
//
210+
// \note Field need not be set (or set to \c #TYPE_OTHER)
211+
// if road marking type (\c #type) does not require it.
212+
//
213+
// \rules
214+
// check_if this.type is_greater_than_or_equal_to 2 else do_check is_set
215+
// check_if this.type is_less_than_or_equal_to 4 else do_check is_set
216+
// \endrules
217+
//
152218
optional string sub_code = 11;
153219

154220
// Definition of road marking types.
155221
//
156-
// \attention Deprecated: OpenDRIVE categorization for traffic signs is more generic than OSI enum
157-
// (see <a href="https://releases.asam.net/OpenDRIVE/1.6.0/ASAM_OpenDRIVE_BS_V1-6-0.html#_signals">OpenDRIVE V1-6-0</a>).<br>
158-
// How the Type will be dealt with in future will be discussed in Harmonization OpenX group.<br>
159-
// Deprecated status planned for version 4.0.0
160-
//
161222
enum Type
162223
{
163224
// Type of road marking is unknown (must not be used in ground

0 commit comments

Comments
 (0)