telem_stage.hpp

Go to the documentation of this file.

/** \file telem_stage.hpp
  * \brief The MagAO-X logger telem_stage log type.
  * \author Jared R. Males (jaredmales@gmail.com)
  *
  * \ingroup logger_types_files
  *
  * History:
  * - 2018-09-06 created by JRM
  */
#ifndef logger_types_telem_stage_hpp
#define logger_types_telem_stage_hpp
 
#include "generated/telem_stage_generated.h"
#include "flatbuffer_log.hpp"
 
namespace MagAOX
{
namespace logger
{
 
 
/// Log entry recording stdMotionStage status.
/** \ingroup logger_types
  */
struct telem_stage : public flatbuffer_log
{
   ///The event code
   static const flatlogs::eventCodeT eventCode = eventCodes::TELEM_STAGE;
 
   ///The default level
   static const flatlogs::logPrioT defaultLevel = flatlogs::logPrio::LOG_TELEM;
 
   static timespec lastRecord; ///< The timestamp of the last time this log was recorded.  Used by the telemetry system.
 
   ///The type of the input message
   struct messageT : public fbMessage
   {
      ///Construct from components
      messageT( const int8_t & moving,         ///<[in] whether or not stage is in motion
                const float & preset,         ///<[in] current position of stage in preset units
                const std::string & presetName ///<[in] current preset name
              )
      {
         auto _name = builder.CreateString(presetName);
 
         auto fp = CreateTelem_stage_fb(builder, moving, preset, _name);
         builder.Finish(fp);
      }
 
   };
 
   static bool verify( flatlogs::bufferPtrT & logBuff,  ///< [in] Buffer containing the flatbuffer serialized message.
                       flatlogs::msgLenT len            ///< [in] length of msgBuffer.
                     )
   {
      auto verifier = flatbuffers::Verifier( static_cast<uint8_t*>(flatlogs::logHeader::messageBuffer(logBuff)), static_cast<size_t>(len));
      return VerifyTelem_stage_fbBuffer(verifier);
   }
 
   ///Get the message formatte for human consumption.
   static std::string msgString( void * msgBuffer,  /**< [in] Buffer containing the flatbuffer serialized message.*/
                                 flatlogs::msgLenT len  /**< [in] [unused] length of msgBuffer.*/
                               )
   {
      static_cast<void>(len);
 
      auto fbs = GetTelem_stage_fb(msgBuffer);
 
      std::string msg = "[stage] ";
 
      msg += "status: ";
      if(fbs->moving() == -2) msg += " OFF ";
      else if(fbs->moving() == -1) msg += " NOTHOMED ";
      else if(fbs->moving() == 0) msg += " STOPPED ";
      else if(fbs->moving() == 1) msg += " MOVING ";
      else if(fbs->moving() == 2) msg += " HOMING ";
 
      msg += "preset: ";
      msg += std::to_string(fbs->preset()) + " ";
 
      msg += "name: ";
      if(fbs->presetName())
      {
         msg += fbs->presetName()->c_str();
      }
 
      return msg;
 
   }
 
   static int moving( void * msgBuffer )
   {
      auto fbs = GetTelem_stage_fb(msgBuffer);
      return fbs->moving();
   }
 
   static float preset( void * msgBuffer )
   {
      auto fbs = GetTelem_stage_fb(msgBuffer);
      return fbs->preset();
   }
 
   static std::string presetName( void * msgBuffer )
   {
      auto fbs = GetTelem_stage_fb(msgBuffer);
      if(fbs->presetName())
      {
         return std::string(fbs->presetName()->c_str());
      }
      else return std::string();
   }
 
   /// Get the logMetaDetail for a member by name
   /**
     * \returns the a logMetaDetail filled in with the appropriate details
     * \returns an empty logMetaDetail if member not recognized
     */
   static logMetaDetail getAccessor( const std::string & member /**< [in] the name of the member */ )
   {
      if(     member == "moving") return logMetaDetail({"MOVING", logMeta::valTypes::Int, logMeta::metaTypes::State, reinterpret_cast<void*>(&moving)});
      else if(member == "preset") return logMetaDetail({"PRESET POSITION", logMeta::valTypes::Float, logMeta::metaTypes::State, reinterpret_cast<void*>(&preset)});
      else if(member == "presetName") return logMetaDetail({"PRESET NAME", logMeta::valTypes::String, logMeta::metaTypes::State, reinterpret_cast<void*>(&presetName)});
      else
      {
         std::cerr << "No member " << member << " in telem_stage\n";
         return logMetaDetail();
      }
   }
 
}; //telem_stage
 
 
 
} //namespace logger
} //namespace MagAOX
 
#endif //logger_types_telem_stage_hpp