Skip to content

Commit 0a20774

Browse files
thomassedlmayerpmai
authored andcommitted
Clarify documentation of semantic colors
Signed-off-by: Thomas Sedlmayer <tsedlmayer@pmsfit.de>
1 parent bac6410 commit 0a20774

3 files changed

Lines changed: 25 additions & 6 deletions

File tree

osi_lane.proto

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -905,7 +905,10 @@ message LaneBoundary
905905
//
906906
optional Type type = 1;
907907

908-
// The color of the lane boundary in case of lane markings.
908+
// The semantic color of the lane boundary in case of lane markings.
909+
//
910+
// \note The color types represent the semantic classification of
911+
// lane markings only. They do not represent an actual visual appearance.
909912
//
910913
optional Color color = 2;
911914

@@ -987,10 +990,13 @@ message LaneBoundary
987990
TYPE_STRUCTURE = 13;
988991
}
989992

990-
// The color of the lane boundary in case of a lane markings.
993+
// The semantic color of the lane boundary in case of a lane markings.
991994
// Lane markings that alternate in color must be represented by
992995
// individual \c LaneBoundary segments.
993996
//
997+
// \note The color types represent the semantic color classification of
998+
// lane markings only. They do not represent an actual visual appearance.
999+
//
9941000
enum Color
9951001
{
9961002
// Color of marking is unknown. Value must not be used in ground

osi_roadmarking.proto

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,11 @@ message RoadMarking
113113
//
114114
optional TrafficSign.MainSign.Classification.Type traffic_main_sign_type = 2;
115115

116-
// The monochrome color of the road marking.
116+
// The semantic monochrome color of the road marking.
117+
//
118+
// \note The color types represent the semantic color classification of
119+
// road markings only. They do not represent an actual visual appearance.
120+
117121
// \note Field need not be set (or set to \c #COLOR_OTHER)
118122
// if road marking type does not require it (e.g. for \c #type ==
119123
// \c #TYPE_PAINTED_TRAFFIC_SIGN).
@@ -286,7 +290,10 @@ message RoadMarking
286290
TYPE_GENERIC_TEXT = 7;
287291
}
288292

289-
// Definition of road marking colors
293+
// Definition of semantic road marking colors
294+
//
295+
// \note The color types represent the semantic classification of
296+
// road markings only. They do not represent an actual visual appearance.
290297
//
291298
enum Color
292299
{

osi_trafficlight.proto

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,10 @@ message TrafficLight
6868
//
6969
message Classification
7070
{
71-
// The color of the traffic light.
71+
// The semantic color of the traffic light.
72+
//
73+
// \note The color types represent the semantic color classification of a
74+
// traffic light only. They do not represent an actual visual appearance.
7275
//
7376
// \note If the color of the traffic light is known (from history or
7477
// geometrical arrangement) and the state \c #mode is
@@ -116,7 +119,10 @@ message TrafficLight
116119
//
117120
optional bool is_out_of_service = 6;
118121

119-
// Definition of colors for traffic lights.
122+
// Definition of semantic colors for traffic lights.
123+
//
124+
// \note The color types represent the semantic classification of a traffic light
125+
// only. They do not represent an actual visual appearance.
120126
//
121127
enum Color
122128
{

0 commit comments

Comments
 (0)