Line data Source code
1 : /** \file telem_sparkleclock.hpp
2 : * \brief The MagAO-X logger telem_sparkleclock log type.
3 : * \author Jared R. Males (jaredmales@gmail.com)
4 : *
5 : * \ingroup logger_types_files
6 : *
7 : * History:
8 : * - 2022-02-06 created by JRM
9 : */
10 : #ifndef logger_types_telem_sparkleclock_hpp
11 : #define logger_types_telem_sparkleclock_hpp
12 :
13 : #include "generated/telem_sparkleclock_generated.h"
14 : #include "flatbuffer_log.hpp"
15 :
16 : namespace MagAOX
17 : {
18 : namespace logger
19 : {
20 :
21 :
22 : /// Log entry recording sparkle clock status
23 : /** \ingroup logger_types
24 : */
25 : struct telem_sparkleclock : public flatbuffer_log
26 : {
27 : ///The event code
28 : static const flatlogs::eventCodeT eventCode = eventCodes::TELEM_DMSPECK;
29 :
30 : ///The default level
31 : static const flatlogs::logPrioT defaultLevel = flatlogs::logPrio::LOG_TELEM;
32 :
33 : static timespec lastRecord; ///< The timestamp 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 1 : messageT( const bool & modulating, ///< [in] whether or not the speckle is being modulated
40 : const bool & trigger, ///< [in] whether or not the speckle is being triggered
41 : const float & frequency, ///< [in] frequency of modulation is not triggered
42 : const float & interval, ///< [in] time for one complete cycle of the sparkle clock (e.g. exposure time of some camera)
43 : const std::vector<float> & separations, ///< [in] the separations of the speckle(s)
44 : const float & angleOffset, ///< [in] starting angle offset of the sparkle clock
45 : const float & amplitude ///< [in] starting angle offset of the sparkle clock
46 : )
47 1 : {
48 1 : auto _separationsVec = builder.CreateVector(separations);
49 : // auto _anglesVec = builder.CreateVector(angles);
50 : // auto _amplitudesVec = builder.CreateVector(amplitudes);
51 : // auto _crossesVec = builder.CreateVector(crosses);
52 :
53 1 : auto fp = CreateTelem_sparkleclock_fb(builder, modulating, trigger, frequency, interval, _separationsVec, angleOffset, amplitude);
54 1 : builder.Finish(fp);
55 1 : }
56 :
57 : };
58 :
59 1 : static bool verify( flatlogs::bufferPtrT & logBuff, ///< [in] Buffer containing the flatbuffer serialized message.
60 : flatlogs::msgLenT len ///< [in] length of msgBuffer.
61 : )
62 : {
63 1 : auto verifier = flatbuffers::Verifier( static_cast<uint8_t*>(flatlogs::logHeader::messageBuffer(logBuff)), static_cast<size_t>(len));
64 2 : return VerifyTelem_sparkleclock_fbBuffer(verifier);
65 : }
66 :
67 : ///Get the message formatte for human consumption.
68 0 : static std::string msgString( void * msgBuffer, /**< [in] Buffer containing the flatbuffer serialized message.*/
69 : flatlogs::msgLenT len /**< [in] [unused] length of msgBuffer.*/
70 : )
71 : {
72 : static_cast<void>(len);
73 :
74 0 : auto fbs = GetTelem_sparkleclock_fb(msgBuffer);
75 :
76 0 : std::string msg = "[sparkleclock] ";
77 :
78 0 : if(!fbs->modulating())
79 : {
80 0 : msg += "not modulating";
81 0 : return msg;
82 : }
83 :
84 0 : msg += "modulating";
85 0 : if(fbs->trigger())
86 : {
87 0 : msg += " by trigger ";
88 : }
89 : else
90 : {
91 0 : msg += " at ";
92 0 : msg += std::to_string(fbs->frequency());
93 0 : msg += " Hz ";
94 : }
95 :
96 0 : msg += "seps: ";
97 0 : for(flatbuffers::Vector<float>::const_iterator it = fbs->separations()->begin(); it != fbs->separations()->end(); ++it)
98 : {
99 0 : msg+= std::to_string(*it);
100 0 : msg+= " ";
101 : }
102 0 : msg += "angle offset: ";
103 0 : msg += std::to_string(fbs->angleOffset());
104 0 : msg += "amp: ";
105 0 : msg += std::to_string(fbs->amplitude());
106 :
107 0 : return msg;
108 :
109 0 : }
110 :
111 0 : static bool modulating( void * msgBuffer )
112 : {
113 0 : auto fbs = GetTelem_sparkleclock_fb(msgBuffer);
114 0 : return fbs->modulating();
115 : }
116 :
117 0 : static bool trigger( void * msgBuffer )
118 : {
119 0 : auto fbs = GetTelem_sparkleclock_fb(msgBuffer);
120 0 : return fbs->trigger();
121 : }
122 :
123 0 : static float frequency( void * msgBuffer )
124 : {
125 0 : auto fbs = GetTelem_sparkleclock_fb(msgBuffer);
126 0 : return fbs->frequency();
127 : }
128 :
129 0 : static std::vector<float> separations( void * msgBuffer )
130 : {
131 0 : std::vector<float> v;
132 :
133 0 : auto fbs = GetTelem_sparkleclock_fb(msgBuffer);
134 :
135 0 : for(flatbuffers::Vector<float>::const_iterator it = fbs->separations()->begin(); it != fbs->separations()->end(); ++it)
136 : {
137 0 : v.push_back(*it);
138 : }
139 :
140 0 : return v;
141 0 : }
142 :
143 0 : static float angleOffset( void * msgBuffer )
144 : {
145 0 : auto fbs = GetTelem_sparkleclock_fb(msgBuffer);
146 0 : return fbs->angleOffset();
147 : }
148 0 : static float amplitude( void * msgBuffer )
149 : {
150 0 : auto fbs = GetTelem_sparkleclock_fb(msgBuffer);
151 0 : return fbs->amplitude();
152 : }
153 :
154 : /// Get the logMetaDetail for a member by name
155 : /**
156 : * \returns the a logMetaDetail filled in with the appropriate details
157 : * \returns an empty logMetaDetail if member not recognized
158 : */
159 1 : static logMetaDetail getAccessor( const std::string & member /**< [in] the name of the member */ )
160 : {
161 1 : if(member == "modulating") return logMetaDetail({"MODULATING", logMeta::valTypes::Bool, logMeta::metaTypes::State, reinterpret_cast<void*>(&modulating)});
162 1 : else if(member == "trigger") return logMetaDetail({"TRIGGERED", logMeta::valTypes::Bool, logMeta::metaTypes::State, reinterpret_cast<void*>(&trigger)});
163 1 : else if(member == "frequency") return logMetaDetail({"FREQUENCY", logMeta::valTypes::Float, logMeta::metaTypes::State, reinterpret_cast<void*>(&frequency)});
164 1 : else if(member == "separations") return logMetaDetail({"SEPARATIONS", logMeta::valTypes::Vector_Float, logMeta::metaTypes::State, reinterpret_cast<void*>(&separations)});
165 1 : else if(member == "angleOffset") return logMetaDetail({"ANGLEOFFSET", logMeta::valTypes::Float, logMeta::metaTypes::State, reinterpret_cast<void*>(&angleOffset)});
166 1 : else if(member == "amplitude") return logMetaDetail({"AMPLITUDES", logMeta::valTypes::Float, logMeta::metaTypes::State, reinterpret_cast<void*>(&litude)});
167 : else
168 : {
169 1 : std::cerr << "No member " << member << " in telem_sparkleclock\n";
170 1 : return logMetaDetail();
171 : }
172 : }
173 :
174 : }; //telem_sparkleclock
175 :
176 :
177 :
178 : } //namespace logger
179 : } //namespace MagAOX
180 :
181 : #endif //logger_types_telem_sparkleclock_hpp
182 :
|
