From 0e230c1fe3d7595a08dc9baf04dc6ad131b23e80 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 19 Dec 2024 18:07:51 +0000 Subject: [PATCH] Update documentation --- omega/develop/_sources/devGuide/TimeMgr.md.txt | 16 ++++++++++++---- omega/develop/devGuide/TimeMgr.html | 16 ++++++++++++---- omega/develop/searchindex.js | 2 +- 3 files changed, 25 insertions(+), 9 deletions(-) diff --git a/omega/develop/_sources/devGuide/TimeMgr.md.txt b/omega/develop/_sources/devGuide/TimeMgr.md.txt index 8adfe5329358..fb857d9e2950 100644 --- a/omega/develop/_sources/devGuide/TimeMgr.md.txt +++ b/omega/develop/_sources/devGuide/TimeMgr.md.txt @@ -159,16 +159,24 @@ is set as the new ring time: ```c++ SingleAlarm.reset(NewAlarmTime); ``` -If the Alarm is periodic, the new ring time will be set to the next interval -boundary after the input time: +If the Alarm is periodic, the ringing will be switched off as above and the +new ring time will be set to the next interval boundary after the input time. +The interval boundary is an integer number of intervals after the start time +provided on Alarm creation. ```c++ PeriodicAlarm.reset(CurrentTime); ``` -This Alarm will ring next at `CurrentTime + AlarmInterval`. An Alarm can be -permanently stopped using the `stop` method: +An Alarm can be permanently stopped using the `stop` method: ```c++ SingleAlarm.stop(); ``` +It is sometimes useful to retrieve other aspects of a periodic Alarm, namely +the Alarm interval and the last time the Alarm was ringing. Two retrieval +functions are provided that return const pointers to these values: +```c++ +const TimeInterval *AlarmInterval = PeriodicAlarm.getInterval(); +const TimeInstant *PriorRingTime = PeriodicAlarm.getRingTimePrev(); +``` ### 6. Clock diff --git a/omega/develop/devGuide/TimeMgr.html b/omega/develop/devGuide/TimeMgr.html index 90e5ba9b913f..0463b16ccc5d 100644 --- a/omega/develop/devGuide/TimeMgr.html +++ b/omega/develop/devGuide/TimeMgr.html @@ -327,16 +327,24 @@
SingleAlarm.reset(NewAlarmTime);
If the Alarm is periodic, the new ring time will be set to the next interval -boundary after the input time:
+If the Alarm is periodic, the ringing will be switched off as above and the +new ring time will be set to the next interval boundary after the input time. +The interval boundary is an integer number of intervals after the start time +provided on Alarm creation.
PeriodicAlarm.reset(CurrentTime);
This Alarm will ring next at CurrentTime + AlarmInterval
. An Alarm can be
-permanently stopped using the stop
method:
An Alarm can be permanently stopped using the stop
method:
SingleAlarm.stop();
It is sometimes useful to retrieve other aspects of a periodic Alarm, namely +the Alarm interval and the last time the Alarm was ringing. Two retrieval +functions are provided that return const pointers to these values:
+const TimeInterval *AlarmInterval = PeriodicAlarm.getInterval();
+const TimeInstant *PriorRingTime = PeriodicAlarm.getRingTimePrev();
+