API
 
Loading...
Searching...
No Matches
telem_telvane.hpp
Go to the documentation of this file.
1/** \file telem_telvane.hpp
2 * \brief The MagAO-X logger telem_telvane log type.
3 * \author Jared R. Males (jaredmales@gmail.com)
4 *
5 * \ingroup logger_types_files
6 *
7 * History:
8 * - 2018-09-06 created by JRM
9 */
10#ifndef logger_types_telem_telvane_hpp
11#define logger_types_telem_telvane_hpp
12
14#include "flatbuffer_log.hpp"
15
16namespace MagAOX
17{
18namespace logger
19{
20
21
22/// Log entry recording the build-time git state.
23/** \ingroup logger_types
24 */
26{
27 ///The event code
29
30 ///The default level
32
33 static timespec lastRecord; ///< The time of the last time this log was recorded. Used by the telemetry system.
34
35 ///The type of the input message
36 struct messageT : public fbMessage
37 {
38 ///Construct from components
39 messageT( const double & secz, ///< [in] secondary z-position
40 const double & encz, ///< [in] secondary z-encoder
41 const double & secx, ///< [in] secondary x-position
42 const double & encx, ///< [in] secondary x-encoder
43 const double & secy, ///< [in] secondary y-position
44 const double & ency, ///< [in] secondary y-encoder
45 const double & sech, ///< [in] secondary h-position
46 const double & ench, ///< [in] secondary h-encoder
47 const double & secv, ///< [in] secondary v-position
48 const double & encv ///< [in] secondary v-encoder
49 )
50 {
52 builder.Finish(fp);
53 }
54
55 };
56
57
58 static bool verify( flatlogs::bufferPtrT & logBuff, ///< [in] Buffer containing the flatbuffer serialized message.
59 flatlogs::msgLenT len ///< [in] length of msgBuffer.
60 )
61 {
62 auto verifier = flatbuffers::Verifier( static_cast<uint8_t*>(flatlogs::logHeader::messageBuffer(logBuff)), static_cast<size_t>(len));
63 return VerifyTelem_telvane_fbBuffer(verifier);
64 }
65
66 ///Get the message formatte for human consumption.
67 static std::string msgString( void * msgBuffer, /**< [in] Buffer containing the flatbuffer serialized message.*/
68 flatlogs::msgLenT len /**< [in] [unused] length of msgBuffer.*/
69 )
70 {
71 static_cast<void>(len);
72
73 auto fbs = GetTelem_telvane_fb(msgBuffer);
74
75 std::string msg = "[telvane] ";
76
77 msg += "secz: ";
78 msg += std::to_string(fbs->secz()) + " ";
79
80 msg += "encz: ";
81 msg += std::to_string(fbs->encz()) + " ";
82
83 msg += "secx: ";
84 msg += std::to_string(fbs->secx()) + " ";
85
86 msg += "encx: ";
87 msg += std::to_string(fbs->encx()) + " ";
88
89 msg += "secy: ";
90 msg += std::to_string(fbs->secy()) + " ";
91
92 msg += "ency: ";
93 msg += std::to_string(fbs->ency()) + " ";
94
95 msg += "sech: ";
96 msg += std::to_string(fbs->sech()) + " ";
97
98 msg += "ench: ";
99 msg += std::to_string(fbs->ench()) + " ";
100
101 msg += "secv: ";
102 msg += std::to_string(fbs->secv()) + " ";
103
104 msg += "encv: ";
105 msg += std::to_string(fbs->encv()) + " ";
106
107 return msg;
108
109 }
110
111 static double secz( void * msgBuffer /**< [in] Buffer containing the flatbuffer serialized message.*/ )
112 {
113 auto fbs = GetTelem_telvane_fb(msgBuffer);
114
115 return fbs->secz();
116 }
117
118 static double encz( void * msgBuffer /**< [in] Buffer containing the flatbuffer serialized message.*/ )
119 {
120 auto fbs = GetTelem_telvane_fb(msgBuffer);
121
122 return fbs->encz();
123 }
124
125 static double secx( void * msgBuffer /**< [in] Buffer containing the flatbuffer serialized message.*/ )
126 {
127 auto fbs = GetTelem_telvane_fb(msgBuffer);
128
129 return fbs->secx();
130 }
131
132 static double encx( void * msgBuffer /**< [in] Buffer containing the flatbuffer serialized message.*/ )
133 {
134 auto fbs = GetTelem_telvane_fb(msgBuffer);
135
136 return fbs->encx();
137 }
138
139 static double secy( void * msgBuffer /**< [in] Buffer containing the flatbuffer serialized message.*/ )
140 {
141 auto fbs = GetTelem_telvane_fb(msgBuffer);
142
143 return fbs->secy();
144 }
145
146 static double ency( void * msgBuffer /**< [in] Buffer containing the flatbuffer serialized message.*/ )
147 {
148 auto fbs = GetTelem_telvane_fb(msgBuffer);
149
150 return fbs->ency();
151 }
152
153 static double sech( void * msgBuffer /**< [in] Buffer containing the flatbuffer serialized message.*/ )
154 {
155 auto fbs = GetTelem_telvane_fb(msgBuffer);
156
157 return fbs->sech();
158 }
159
160 static double ench( void * msgBuffer /**< [in] Buffer containing the flatbuffer serialized message.*/ )
161 {
162 auto fbs = GetTelem_telvane_fb(msgBuffer);
163
164 return fbs->ench();
165 }
166
167 static double secv( void * msgBuffer /**< [in] Buffer containing the flatbuffer serialized message.*/ )
168 {
169 auto fbs = GetTelem_telvane_fb(msgBuffer);
170
171 return fbs->secv();
172 }
173
174 static double encv( void * msgBuffer /**< [in] Buffer containing the flatbuffer serialized message.*/ )
175 {
176 auto fbs = GetTelem_telvane_fb(msgBuffer);
177
178 return fbs->encv();
179 }
180
181 /// Get the logMetaDetail for a member by name
182 /**
183 * \returns the a logMetaDetail filled in with the appropriate details
184 * \returns an empty logMetaDetail if member not recognized
185 */
186 static logMetaDetail getAccessor( const std::string & member /**< [in] the name of the member */ )
187 {
188 if( member == "secz") return logMetaDetail({"SECONDARY Z", "secondary z position", logMeta::valTypes::Double, logMeta::metaTypes::State, reinterpret_cast<void*>(&secz), false});
189 else if( member == "encz") return logMetaDetail({"ENCODER Z", "secondary z encoder", logMeta::valTypes::Double, logMeta::metaTypes::State, reinterpret_cast<void*>(&encz), false});
190 else if( member == "secx") return logMetaDetail({"SECONDARY X", "secondary X position", logMeta::valTypes::Double, logMeta::metaTypes::State, reinterpret_cast<void*>(&secx), false});
191 else if( member == "encx") return logMetaDetail({"ENCODER X", "secondary X encoder", logMeta::valTypes::Double, logMeta::metaTypes::State, reinterpret_cast<void*>(&encx), false});
192 else if( member == "secy") return logMetaDetail({"SECONDARY Y", "secondary Y position", logMeta::valTypes::Double, logMeta::metaTypes::State, reinterpret_cast<void*>(&secy), false});
193 else if( member == "ency") return logMetaDetail({"ENCODER Y", "secondary Y encoder", logMeta::valTypes::Double, logMeta::metaTypes::State, reinterpret_cast<void*>(&ency), false});
194 else if( member == "sech") return logMetaDetail({"SECONDARY H", "secondary H position", logMeta::valTypes::Double, logMeta::metaTypes::State, reinterpret_cast<void*>(&sech), false});
195 else if( member == "ench") return logMetaDetail({"ENCODER H", "secondary H encoder", logMeta::valTypes::Double, logMeta::metaTypes::State, reinterpret_cast<void*>(&ench), false});
196 else if( member == "secv") return logMetaDetail({"SECONDARY V", "secondary V position", logMeta::valTypes::Double, logMeta::metaTypes::State, reinterpret_cast<void*>(&secv), false});
197 else if( member == "encv") return logMetaDetail({"ENCODER V", "secondary V encoder", logMeta::valTypes::Double, logMeta::metaTypes::State, reinterpret_cast<void*>(&encv), false});
198 else
199 {
200 std::cerr << "No member " << member << " in telem_telvane\n";
201 return logMetaDetail();
202 }
203 }
204}; //telem_telvane
205
206
207
208} //namespace logger
209} //namespace MagAOX
210
211#endif //logger_types_telem_telvane_hpp
212
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.
std::shared_ptr< char > bufferPtrT
The log entry buffer smart pointer.
Definition logHeader.hpp:58
static constexpr flatlogs::eventCodeT TELEM_TELVANE
Definition logCodes.hpp:35
const MagAOX::logger::Telem_telvane_fb * GetTelem_telvane_fb(const void *buf)
inline ::flatbuffers::Offset< Telem_telvane_fb > CreateTelem_telvane_fb(::flatbuffers::FlatBufferBuilder &_fbb, double secz=0.0, double encz=0.0, double secx=0.0, double encx=0.0, double secy=0.0, double ency=0.0, double sech=0.0, double ench=0.0, double secv=0.0, double encv=0.0)
bool VerifyTelem_telvane_fbBuffer(::flatbuffers::Verifier &verifier)
Definition dm.hpp:28
static constexpr logPrioT LOG_TELEM
A telemetry recording.
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.
messageT(const double &secz, const double &encz, const double &secx, const double &encx, const double &secy, const double &ency, const double &sech, const double &ench, const double &secv, const double &encv)
Construct from components.
Log entry recording the build-time git state.
static double secx(void *msgBuffer)
static double ench(void *msgBuffer)
static double secy(void *msgBuffer)
static double encx(void *msgBuffer)
static bool verify(flatlogs::bufferPtrT &logBuff, flatlogs::msgLenT len)
static double secv(void *msgBuffer)
static timespec lastRecord
The time of the last time this log was recorded. Used by the telemetry system.
static double ency(void *msgBuffer)
static const flatlogs::eventCodeT eventCode
The event code.
static std::string msgString(void *msgBuffer, flatlogs::msgLenT len)
Get the message formatte for human consumption.
static double sech(void *msgBuffer)
static logMetaDetail getAccessor(const std::string &member)
Get the logMetaDetail for a member by name.
static double secz(void *msgBuffer)
static double encv(void *msgBuffer)
static double encz(void *msgBuffer)
static const flatlogs::logPrioT defaultLevel
The default level.