F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
Fw::Logger Class Referenceabstract

#include <Fw/Logger/Logger.hpp>

Inheritance diagram for Fw::Logger:
Os::Log

Public Member Functions

virtual void log (const char *fmt, POINTER_CAST a0=0, POINTER_CAST a1=0, POINTER_CAST a2=0, POINTER_CAST a3=0, POINTER_CAST a4=0, POINTER_CAST a5=0, POINTER_CAST a6=0, POINTER_CAST a7=0, POINTER_CAST a8=0, POINTER_CAST a9=0)=0
 
virtual ~Logger ()
 

Static Public Member Functions

static void logMsg (const char *fmt, POINTER_CAST a0=0, POINTER_CAST a1=0, POINTER_CAST a2=0, POINTER_CAST a3=0, POINTER_CAST a4=0, POINTER_CAST a5=0, POINTER_CAST a6=0, POINTER_CAST a7=0, POINTER_CAST a8=0, POINTER_CAST a9=0)
 
static void registerLogger (Logger *logger)
 Static logger to use when calling the above 'logMsg' function. More...
 

Static Public Attributes

static Loggers_current_logger = nullptr
 

Detailed Description

Definition at line 15 of file Logger.hpp.

Constructor & Destructor Documentation

◆ ~Logger()

Fw::Logger::~Logger ( )
virtual

Definition at line 31 of file Logger.cpp.

Member Function Documentation

◆ log()

virtual void Fw::Logger::log ( const char *  fmt,
POINTER_CAST  a0 = 0,
POINTER_CAST  a1 = 0,
POINTER_CAST  a2 = 0,
POINTER_CAST  a3 = 0,
POINTER_CAST  a4 = 0,
POINTER_CAST  a5 = 0,
POINTER_CAST  a6 = 0,
POINTER_CAST  a7 = 0,
POINTER_CAST  a8 = 0,
POINTER_CAST  a9 = 0 
)
pure virtual

Function called on the logger to log a message. This is abstract virtual method and must be supplied by the subclass. This logger object should be registered with the Fw::Log::registerLogger function.

Parameters
fmtformat string in which to place arguments
a0zeroth argument. (Default: 0)
a1first argument. (Default: 0)
a2second argument. (Default: 0)
a3third argument. (Default: 0)
a4fourth argument. (Default: 0)
a5fifth argument. (Default: 0)
a6sixth argument. (Default: 0)
a7seventh argument. (Default: 0)
a8eighth argument. (Default: 0)
a9ninth argument. (Default: 0)

Implemented in Os::Log.

◆ logMsg()

void Fw::Logger::logMsg ( const char *  fmt,
POINTER_CAST  a0 = 0,
POINTER_CAST  a1 = 0,
POINTER_CAST  a2 = 0,
POINTER_CAST  a3 = 0,
POINTER_CAST  a4 = 0,
POINTER_CAST  a5 = 0,
POINTER_CAST  a6 = 0,
POINTER_CAST  a7 = 0,
POINTER_CAST  a8 = 0,
POINTER_CAST  a9 = 0 
)
static

Logs a message using the currently specified static logger. If a logger is not registered, then the log message is dropped.

Parameters
fmtformat string in which to place arguments
a0zeroth argument. (Default: 0)
a1first argument. (Default: 0)
a2second argument. (Default: 0)
a3third argument. (Default: 0)
a4fourth argument. (Default: 0)
a5fifth argument. (Default: 0)
a6sixth argument. (Default: 0)
a7seventh argument. (Default: 0)
a8eighth argument. (Default: 0)
a9ninth argument. (Default: 0)

Definition at line 18 of file Logger.cpp.

◆ registerLogger()

void Fw::Logger::registerLogger ( Logger logger)
static

Static logger to use when calling the above 'logMsg' function.

Registers the static logger for use with the Fw::Log::logMsg function. This must be a subclass of Fw::Log.

Parameters
loggerlogger to log to when Fw::Log::logMsg is called.

Definition at line 27 of file Logger.cpp.

Member Data Documentation

◆ s_current_logger

Logger * Fw::Logger::s_current_logger = nullptr
static

Definition at line 84 of file Logger.hpp.


The documentation for this class was generated from the following files: