API
telem_usage.hpp
Go to the documentation of this file.
1 /** \file telem_usage.hpp
2  * \brief The MagAO-X logger telem_usage log type.
3  * \author Chris Bohlman (cbohlmanaz@gmail.com)
4  *
5  * \ingroup logger_types_files
6  *
7  * History:
8  * - 2018-10-15 created by CJB
9  */
10 #ifndef logger_types_telem_usage_hpp
11 #define logger_types_telem_usage_hpp
12 
13 #include "generated/telem_usage_generated.h"
14 #include "flatbuffer_log.hpp"
15 
16 namespace MagAOX
17 {
18 namespace logger
19 {
20 
21 
22 /// Log entry recording hdd temperatures
23 /** \ingroup logger_types
24  */
25 struct telem_usage : public flatbuffer_log
26 {
27 
28  static const flatlogs::eventCodeT eventCode = eventCodes::TELEM_USAGE;
30 
31  static timespec lastRecord; ///< The time of the last time this log was recorded. Used by the telemetry system.
32 
33  ///The type of the input message
34  struct messageT : public fbMessage
35  {
36  ///Construct from components
37  messageT( float ram,
38  float boot,
39  float root,
40  float data
41  )
42  {
43 
44  auto fp = CreateTelem_usage_fb(builder, ram, boot, root, data );
45 
46  builder.Finish(fp);
47 
48  }
49 
50  };
51 
52  static bool verify( flatlogs::bufferPtrT & logBuff, ///< [in] Buffer containing the flatbuffer serialized message.
53  flatlogs::msgLenT len ///< [in] length of msgBuffer.
54  )
55  {
56  auto verifier = flatbuffers::Verifier( static_cast<uint8_t*>(flatlogs::logHeader::messageBuffer(logBuff)), static_cast<size_t>(len));
57  return VerifyTelem_usage_fbBuffer(verifier);
58  }
59 
60  ///Get the message formatted for human consumption.
61  static std::string msgString( void * msgBuffer, /**< [in] Buffer containing the flatbuffer serialized message.*/
62  flatlogs::msgLenT len /**< [in] [unused] length of msgBuffer.*/
63  )
64  {
65 
66  static_cast<void>(len); // unused by most log types
67 
68  auto rgs = GetTelem_usage_fb(msgBuffer);
69 
70  std::string msg = "[usage] ram: ";
71 
72  msg += std::to_string(rgs->ramUsage());
73  msg += " boot: ";
74  msg += std::to_string(rgs->bootUsage());
75  msg += " root: ";
76  msg += std::to_string(rgs->rootUsage());
77  msg += " data: ";
78  msg += std::to_string(rgs->dataUsage());
79 
80  return msg;
81 
82  }
83 
84 }; //telem_usage
85 
86 
87 
88 } //namespace logger
89 } //namespace MagAOX
90 
91 #endif //logger_types_telem_usage_hpp
The MagAO-X logger flatbuffer log base type.
uint16_t eventCodeT
The type of an event code (16-bit unsigned int).
Definition: logDefs.hpp:40
msgLen2T msgLenT
The type used to refer to the message length, regardless of length.
Definition: logDefs.hpp:69
int8_t logPrioT
The type of the log priority code.
Definition: logDefs.hpp:21
static void * messageBuffer(bufferPtrT &logBuffer)
Get the message buffer address.
Definition: logHeader.hpp:621
std::shared_ptr< char > bufferPtrT
The log entry buffer smart pointer.
Definition: logHeader.hpp:58
std::stringstream msg
Definition: dm.hpp:24
constexpr static logPrioT LOG_TELEM
A telemetry recording.
Definition: logPriority.hpp:58
Message type for resolving log messages with a f.b. builder.
flatbuffers::FlatBufferBuilder builder
Base class for logs consisting of a flatbuffer message.
The type of the input message.
Definition: telem_usage.hpp:35
messageT(float ram, float boot, float root, float data)
Construct from components.
Definition: telem_usage.hpp:37
Log entry recording hdd temperatures.
Definition: telem_usage.hpp:26
static std::string msgString(void *msgBuffer, flatlogs::msgLenT len)
Get the message formatted for human consumption.
Definition: telem_usage.hpp:61
static const flatlogs::logPrioT defaultLevel
Definition: telem_usage.hpp:29
static bool verify(flatlogs::bufferPtrT &logBuff, flatlogs::msgLenT len)
Definition: telem_usage.hpp:52
static timespec lastRecord
The time of the last time this log was recorded. Used by the telemetry system.
Definition: telem_usage.hpp:31
static const flatlogs::eventCodeT eventCode
Definition: telem_usage.hpp:28