Wrote IDataLogger header file#89
Conversation
Harrison-O
left a comment
Harrison-O
left a comment
There was a problem hiding this comment.
A good first attempt but needs some touch ups.
Please go over the comments and make changes.
| /** | ||
| * @author Jarod Harris | ||
| * @date 22/04/2020 (d/m/y, UTC+08:00) | ||
| * @brief IDataLogger for ClimbingClock logger |
There was a problem hiding this comment.
Not quite, this interface should work for any project, not just Climbing clock
| #ifndef IDataLogger_h | ||
| #define IDataLogger_h | ||
|
|
||
| #include "Arduino.h" |
There was a problem hiding this comment.
We're not using anything in the Arduino library so this inclusion can be removed
| * @param subsystem Name of relevant subsystem for alert | ||
| */ | ||
| virtual void logInfo(char[] timestamp, char[] subsystem, char[] message) = 0; | ||
| /** |
There was a problem hiding this comment.
Please insert an empty line above this line.
| * @param subsystem Name of relevant subsystem for alert | ||
| */ | ||
| virtual void logWarning(char[] timestamp, char[] subsystem, char[] message) = 0; | ||
| /** |
There was a problem hiding this comment.
Please insert an empty line above
| * @param subsystem Name of relevant subsystem for alert | ||
| */ | ||
| virtual void logError(char[] timestamp, char[] subsystem, char[] message) = 0; | ||
| /** |
There was a problem hiding this comment.
Insert empty line above and fix indentation
| 2. Must be implemented by a data logger class to implement methods. | ||
|
|
||
| ## How-To Guide | ||
|
|
There was a problem hiding this comment.
How-To Guide no longer needs Public Class Constants, Typedefs, nor Methods, as these are covered in the Doxygen comments. Only the Steps subsection.
| @@ -0,0 +1,28 @@ | |||
| ############################################################################## | |||
| # AUTHOR: Ashley Taylor and Harrison Outram | |||
There was a problem hiding this comment.
Change author to Jarod Harris
| get TemptKEYWORD2 | ||
| faultDetected KEYWORD2 | ||
| setCooling KEYWORD2 | ||
| tempToPower KEYWORD2 |
There was a problem hiding this comment.
Please update method keywords to the ones used in the IDataLogger class.
| @@ -0,0 +1,28 @@ | |||
| ############################################################################## | |||
| # AUTHOR: Ashley Taylor and Harrison Outram | |||
| # DATE: 30/04/2020 (d/m/y, UTC+08:00) | |||
| ############################################################################## | ||
| # AUTHOR: Ashley Taylor and Harrison Outram | ||
| # DATE: 30/04/2020 (d/m/y, UTC+08:00) | ||
| # VERSION: 1.1 |
There was a problem hiding this comment.
Change version number to 1.0
2 participants
No description provided.