From e7ddde7f1cce921a1d467b16bd6ad63c96ed810e Mon Sep 17 00:00:00 2001
From: thodkatz <thodkatz@gmail.com>
Date: Tue, 11 Dec 2018 18:43:23 +0200
Subject: [PATCH] Better documentation
---
inc/Services/TimeManagementService.hpp | 18 ++++++++++--------
1 file changed, 10 insertions(+), 8 deletions(-)
diff --git a/inc/Services/TimeManagementService.hpp b/inc/Services/TimeManagementService.hpp
index 76b31b67..4e48f775 100644
--- a/inc/Services/TimeManagementService.hpp
+++ b/inc/Services/TimeManagementService.hpp
@@ -5,12 +5,13 @@
#include "Helpers/TimeHelper.hpp"
/**
- * Implementation of the ST[09] time management implementation
+ * Implementation of the ST[09] time management. The current implementation sends
+ * a report with the spacecraft time that is formatted according to the CUC time code format
+ * (check TimeHelper for the format)
*
* @todo When the time comes for the application processes we should consider this: All reports
- * generated by the application process that is identified by APID 0 are time reports.
- * @todo check if we need to implement the time reporting control subservice
- * @todo check if we need to declare the time accuracy that the standard claims in the spacecraft
+ * generated by the application process that is identified by APID 0 are time reports
+ * @todo Declare the time accuracy that the standard claims in the spacecraft
* time reference section(6.9.3.d,e)
*/
class TimeManagementService : public Service {
@@ -22,11 +23,12 @@ public:
/**
* @param seconds the seconds provided from the RTC. This function in general should have
* parameters corresponding with the RTC. For the time being we assume that the RTC has a
- * 32-bit counter that counts seconds(the RTC in Nucleo F103RB!).
+ * 32-bit counter that counts seconds(the RTC in Nucleo F103RB!)
* @todo check if we need spacecraft time reference status
- * @todo The time reports generated by the time reporting subservice are spacecraft time
- * packets. A spacecraft time packet does not carry the message type, consisting of the
- * service type and message subtype
+ * @todo ECSS standard claims: <<The time reports generated by the time reporting subservice
+ * are spacecraft time packets. A spacecraft time packet does not carry the message type,
+ * consisting of the service type and message subtype.>> Check if we need to implement that
+ * or should ignore the standard?
*/
void cucTimeReport(uint32_t seconds);
};
--
GitLab