NASA-AMMOS / NASA-AMMOS/plandev
Contrib Clock uses millisecond
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 128
- Forks
- 33
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 12
Description
srschaff
https://jira.jpl.nasa.gov/browse/AERIEQS-336
Moderate
The model resource for Clock from aerie.contrib uses milliseconds, different than elsewhere in aerie that uses either microseconds or seconds. It would be much easier to use if everything were in seconds, or at least this demonstration Clock resource.
[https://github.com/NASA-AMMOS/aerie/blob/develop/contrib/src/main/java/gov/nasa/jpl/aerie/contrib/models/Clock.java#L13]
This easily leads (led) to confusion when trying to use those Clock resources in scheduling rules that must mix and match between microseconds (eg Recurrence goal interval), seconds (controllable duration parameter), and now microseconds (constraints on clock resource).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Inspect contrib/src/main/java/gov/nasa/jpl/aerie/contrib/models/Clock.java at line 13, then compare its millisecond usage with the seconds and microseconds conventions described in the issue. Clarify the intended unit for this demonstration Clock resource, and consider the change complete when its usage no longer causes the stated unit confusion.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- backend
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100