Skip to content

Commit 56ade19

Browse files
authored
Merge pull request #1129 from JuliaRobotics/25Q2/docs/vardfg
more docs for VariableDFG
2 parents 9057f5e + 989d5a2 commit 56ade19

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/entities/DFGVariable.jl

+5
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,11 @@ getEstimateFields(::MeanMaxPPE) = [:suggested, :max, :mean]
210210
$(TYPEDEF)
211211
212212
The Variable information packed in a way that accomdates multi-lang using json.
213+
214+
Notes:
215+
- timestamp is a `ZonedDateTime` in UTC.
216+
- nstime can be used as mission time, with the convention that the timestamp millis coincide with the mission start nstime
217+
- e.g. timestamp is `2020-01-01 06:30:01.250 UTC` and first nstime is `250_000_000`.
213218
"""
214219
Base.@kwdef struct VariableDFG <: AbstractDFGVariable
215220
id::Union{UUID, Nothing} = nothing

0 commit comments

Comments
 (0)