Developer Documentation
PluginLogger Class Reference

#include <OpenFlipper/Logging/PluginLogging.hh>

Inheritance diagram for PluginLogger:

Signals

void log (Logtype, QString)
 Sends the generated logs to the core.
 

Public Member Functions

 PluginLogger (QString _pluginName, Logtype _type=LOGOUT)
 Standard Constructor. More...
 
 ~PluginLogger ()
 Destructor.
 
void operator<< (const std::string &_s)
 Provide operator for streaming. More...
 

Private Slots

void slotLog (Logtype _type, QString _message)
 Log messages with a given Logtype. More...
 
void slotLog (QString _message)
 Wrapper which logs at LOGOUT Logtype by default. More...
 

Private Attributes

QString pluginName_
 prepend this name to all output messages
 
Logtype defaultLogType_
 Default logtype ( used for streams )
 

Detailed Description

A wrapper class, getting events from an plugin, prepending plugin name to the log and passing it to the core. This class is generated for every plugin of the core. It also does some cleanup of the passed strings.

Definition at line 73 of file PluginLogging.hh.

Constructor & Destructor Documentation

◆ PluginLogger()

PluginLogger::PluginLogger ( QString  _pluginName,
Logtype  _type = LOGOUT 
)

Standard Constructor.

Parameters
_pluginNameName of the Plugin which uses this logger (Prepended to all Output)
_typeDefault log type ( used for streaming operations )

Definition at line 66 of file PluginLogging.cc.

Member Function Documentation

◆ operator<<()

void PluginLogger::operator<< ( const std::string &  _s)

Provide operator for streaming.

This operator is used for streaming ( e.g. catch omerr and omerr streams) and redirect them to the logging widget. The default log level passed to the constructor will be used for the message

Parameters
_sString to display

Definition at line 113 of file PluginLogging.cc.

◆ slotLog [1/2]

void PluginLogger::slotLog ( Logtype  _type,
QString  _message 
)
privateslot

Log messages with a given Logtype.

Receive log events from plugins and pass them to core

Parameters
_typeLogtype (defines the color of the output)
_messageThe message for output

Definition at line 79 of file PluginLogging.cc.

◆ slotLog [2/2]

void PluginLogger::slotLog ( QString  _message)
privateslot

Wrapper which logs at LOGOUT Logtype by default.

Receive log events from plugins (defaults to LOGOUT Message type)

Parameters
_messageThe message for output

Definition at line 95 of file PluginLogging.cc.


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