Skip to content

Commit aa85206

Browse files
ndunningbmwjdsika
authored andcommitted
Added Date to EnvironmentConditions (solves #321) (#323)
* Added unix_timestamp to EnvironmentalConditions. * Clarified area of effect for EnvironmentalConditions. * Added note for the calculations of TimeOfDay message.
1 parent 109a6d5 commit aa85206

File tree

1 file changed

+30
-4
lines changed

1 file changed

+30
-4
lines changed

osi_environment.proto

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,35 @@ package osi3;
99
//
1010
// Definition of light, weather conditions and other environmental conditions.
1111
//
12+
// \note These conditions apply locally around the host vehicle.
13+
//
1214
message EnvironmentalConditions
1315
{
1416
// The ambient illumination of the environment.
1517
//
1618
optional AmbientIllumination ambient_illumination = 1;
1719

18-
// The time of day.
20+
// The time of day at the host vehicles location.
1921
//
2022
optional TimeOfDay time_of_day = 2;
23+
24+
// The Unix epoch (or Unix time or POSIX time or Unix timestamp) is
25+
// the number of seconds that have elapsed since January 1, 1970
26+
// (midnight UTC/GMT), not counting leap seconds
27+
// (in ISO 8601: 1970-01-01T00:00:00Z). Literally speaking the epoch
28+
// is Unix time 0 (midnight 1/1/1970), but 'epoch' is often used as
29+
// a synonym for 'Unix time'. Many Unix systems store epoch dates as
30+
// a signed 32-bit integer, which might cause problems on January 19,
31+
// 2038 (known as the Year 2038 problem or Y2038).
32+
//
33+
// \note You can convert the timestamp using the following [routines
34+
// sorted by languages](https://www.epochconverter.com/#code)
35+
//
36+
// \par References:
37+
// - [1] [Epoch & Unix Timestamp Conversion Tools](https://www.epochconverter.com/)
38+
// - [2] [Wikipedia: Coordinated Universal Time] (https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
39+
//
40+
optional int64 unix_timestamp = 8;
2141

2242
// Atmospheric pressure in Pascal at z=0.0 in world frame (about 101325
2343
// [Pa]).
@@ -258,13 +278,19 @@ message EnvironmentalConditions
258278
}
259279

260280
//
261-
// \brief The time of day at the location of the vehicle.
281+
// \brief The time of day at a specified location.
282+
//
283+
// \note In general the global position of the parent frame should be
284+
// obtainable in order to derive the local time.
285+
// This information can be calculated from the \c #unix_timestamp in
286+
// combination with \c #osi3::GroundTruth::proj_string and the position of
287+
// the corresponding \c #osi3::BaseStationary or \c #osi3::BaseMoving .
262288
//
263289
message TimeOfDay
264290
{
265291
// The number of seconds [s] that have passed since midnight local time.
266-
// Used for determining the current state of the circadian rhythm of a
267-
// driver.
292+
// Used e.g. for determining the current state of the circadian rhythm
293+
// of a driver.
268294
//
269295
// \note No changes of daylight saving time or time zones are
270296
// considered.

0 commit comments

Comments
 (0)