API
Public Member Functions | Public Attributes | List of all members
MagAOX::logger::software_log::messageT Struct Reference

The type of the message. More...

#include <software_log.hpp>

Inheritance diagram for MagAOX::logger::software_log::messageT:
Inheritance graph
Collaboration diagram for MagAOX::logger::software_log::messageT:
Collaboration graph

Public Member Functions

 messageT (const char *file, const uint32_t line, const int32_t errnoCode, const int32_t otherCode, const char *explanation)
 C'tor with full specification. More...
 
 messageT (const char *file, const uint32_t line, const int32_t errnoCode, const int32_t otherCode, const std::string &explanation)
 C'tor with full specification, overloaded for a std::string in explanation. More...
 
 messageT (const char *file, const uint32_t line, const int32_t errnoCode)
 C'tor for errno only – code explanation can be looked up later. More...
 
 messageT (const char *file, const uint32_t line, const int32_t errnoCode, const char *explanation)
 C'tor for errno with additional explanation. More...
 
 messageT (const char *file, const uint32_t line, const int32_t errnoCode, const std::string &explanation)
 C'tor for errno with additional explanation, std::string overload. More...
 
 messageT (const char *file, const uint32_t line, const std::string &explanation)
 C'tor with no codes, just the explanation. More...
 
 messageT (const char *file, const uint32_t line)
 C'tor for a trace log, only the file and line. More...
 

Public Attributes

flatbuffers::FlatBufferBuilder builder
 

Detailed Description

The type of the message.

Definition at line 35 of file software_log.hpp.

Constructor & Destructor Documentation

◆ messageT() [1/7]

MagAOX::logger::software_log::messageT::messageT ( const char *  file,
const uint32_t  line,
const int32_t  errnoCode,
const int32_t  otherCode,
const char *  explanation 
)
inline

C'tor with full specification.

Parameters
[in]fileThe file of the error, should always be \_ \_FILE\_\_
[in]lineThe line number of the error, should always be \_ \_LINE\_\_
[in]errnoCodeThe errno code at the time of the log entry. Only errno should be passed here, so strerror can be used later.
[in]otherCodeSome other error code, such as a return value or library code.
[in]explanationexplanatory text about the software event

Definition at line 38 of file software_log.hpp.

◆ messageT() [2/7]

MagAOX::logger::software_log::messageT::messageT ( const char *  file,
const uint32_t  line,
const int32_t  errnoCode,
const int32_t  otherCode,
const std::string &  explanation 
)
inline

C'tor with full specification, overloaded for a std::string in explanation.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
[in]fileThe file of the error, should always be \_ \_FILE\_\_
[in]lineThe line number of the error, should always be \_ \_LINE\_\_
[in]errnoCodeThe errno code at the time of the log entry. Only errno should be passed here, so strerror can be used later.
[in]otherCodeSome other error code, such as a return value or library code.
[in]explanationexplanatory text about the software event

Definition at line 55 of file software_log.hpp.

◆ messageT() [3/7]

MagAOX::logger::software_log::messageT::messageT ( const char *  file,
const uint32_t  line,
const int32_t  errnoCode 
)
inline

C'tor for errno only – code explanation can be looked up later.

Parameters
[in]fileThe file of the error, should always be \_ \_FILE\_\_
[in]lineThe line number of the error, should always be \_ \_LINE\_\_
[in]errnoCodeThe errno code at the time of the log entry. Only errno should be passed here, so strerror can be used later.

Definition at line 70 of file software_log.hpp.

◆ messageT() [4/7]

MagAOX::logger::software_log::messageT::messageT ( const char *  file,
const uint32_t  line,
const int32_t  errnoCode,
const char *  explanation 
)
inline

C'tor for errno with additional explanation.

Parameters
[in]fileThe file of the error, should always be \_ \_FILE\_\_
[in]lineThe line number of the error, should always be \_ \_LINE\_\_
[in]errnoCodeThe errno code at the time of the log entry. Only errno should be passed here, so strerror can be used later.
[in]explanationexplanatory text about the software event

Definition at line 82 of file software_log.hpp.

◆ messageT() [5/7]

MagAOX::logger::software_log::messageT::messageT ( const char *  file,
const uint32_t  line,
const int32_t  errnoCode,
const std::string &  explanation 
)
inline

C'tor for errno with additional explanation, std::string overload.

Parameters
[in]fileThe file of the error, should always be \_ \_FILE\_\_
[in]lineThe line number of the error, should always be \_ \_LINE\_\_
[in]errnoCodeThe errno code at the time of the log entry. Only errno should be passed here, so strerror can be used later.
[in]explanationexplanatory text about the software event

Definition at line 96 of file software_log.hpp.

◆ messageT() [6/7]

MagAOX::logger::software_log::messageT::messageT ( const char *  file,
const uint32_t  line,
const std::string &  explanation 
)
inline

C'tor with no codes, just the explanation.

Parameters
[in]fileThe file of the error, should always be \_ \_FILE\_\_
[in]lineThe line number of the error, should always be \_ \_LINE\_\_
[in]explanationexplanatory text about the software event

Definition at line 110 of file software_log.hpp.

◆ messageT() [7/7]

MagAOX::logger::software_log::messageT::messageT ( const char *  file,
const uint32_t  line 
)
inline

C'tor for a trace log, only the file and line.

Parameters
[in]fileThe file of the error, should always be \_ \_FILE\_\_
[in]lineThe line number of the error, should always be \_ \_LINE\_\_

Definition at line 123 of file software_log.hpp.

Member Data Documentation

◆ builder

flatbuffers::FlatBufferBuilder MagAOX::logger::fbMessage::builder
inherited

Definition at line 30 of file flatbuffer_log.hpp.

Referenced by MagAOX::logger::telem_sparkleclock::messageT::messageT(), MagAOX::logger::telem_dmspeck::messageT::messageT(), messageT(), MagAOX::logger::string_log::messageT::messageT(), MagAOX::logger::telem_fgtimings::messageT::messageT(), MagAOX::logger::telem_telpos::messageT::messageT(), MagAOX::logger::telem_telvane::messageT::messageT(), MagAOX::logger::telem_telenv::messageT::messageT(), MagAOX::logger::telem_chrony_stats::messageT::messageT(), MagAOX::logger::ocam_temps::messageT::messageT(), MagAOX::logger::telem_cooler::messageT::messageT(), MagAOX::logger::telem_position::messageT::messageT(), MagAOX::logger::telem_zaber::messageT::messageT(), MagAOX::logger::telem_pi335::messageT::messageT(), MagAOX::logger::telem_rhusb::messageT::messageT(), MagAOX::logger::telem_telsee::messageT::messageT(), MagAOX::logger::telem_teldata::messageT::messageT(), MagAOX::logger::telem_stage::messageT::messageT(), MagAOX::logger::telem_telcat::messageT::messageT(), MagAOX::logger::outlet_channel_state::messageT::messageT(), MagAOX::logger::user_log::messageT::messageT(), MagAOX::logger::telem_observer::messageT::messageT(), MagAOX::logger::observer::messageT::messageT(), MagAOX::logger::telem_chrony_status::messageT::messageT(), MagAOX::logger::telem_stdcam::messageT::messageT(), MagAOX::logger::config_log::messageT::messageT(), MagAOX::logger::pico_channel::messageT::messageT(), MagAOX::logger::git_state::messageT::messageT(), MagAOX::logger::telem_blockgains::messageT::messageT(), MagAOX::logger::telem_temps::messageT::messageT(), MagAOX::logger::telem_saving::messageT::messageT(), MagAOX::logger::telem_fxngen::messageT::messageT(), MagAOX::logger::telem_pokeloop::messageT::messageT(), MagAOX::logger::telem_pokecenter::messageT::messageT(), MagAOX::logger::ttmmod_params::messageT::messageT(), MagAOX::logger::telem_loopgain::messageT::messageT(), MagAOX::logger::telem_usage::messageT::messageT(), MagAOX::logger::state_change::messageT::messageT(), MagAOX::logger::saving_state_change::messageT::messageT(), MagAOX::logger::telem_dmmodes::messageT::messageT(), MagAOX::logger::telem_coreloads::messageT::messageT(), MagAOX::logger::telem_coretemps::messageT::messageT(), MagAOX::logger::telem_pico::messageT::messageT(), MagAOX::logger::telem_drivetemps::messageT::messageT(), and MagAOX::logger::outlet_state::messageT::messageT().

The documentation for this struct was generated from the following file: