Logger Class Reference

#include <logger.h>

Inheritance diagram for Logger:

Collaboration diagram for Logger:

Public Slots
void	RemoteLog (REMOTE_LOG_ENTRY LogEntry)
	Receiver a Log Entry via a Public Slot.

Signals
void	CountChanged (int counter)
	A Signal to flag a change in the Number of Log Lines.

Public Member Functions
	Logger (Ui::MainWindow *UI_Window)
	The Log Constructor.
	~Logger ()
	The Log Destructor.
void	Add (LOGGING_SEVERITY Severity, LOGGING_MODE Mode, const QString LogMessage)
	Add a Line to Log (in it matches the current settings)
void	SaveSeverityMask (int SeverityMask)
	Save the Log Severity Mask.
void	SaveModeMask (int ModeMask)
	Save the Log Mode Mask.
void	SetMaxLines (int MaxLogLines)
	Set the maximum number of lines the log will retain.

Private Slots
void	UpdateMaxLogLines (int Value)
void	LogSelectItem (QListWidgetItem *Item)
void	SaveLog (void)
	Save the Log Lines to a File.
void	ClearLog (void)
	Clear the lines from the Log.
void	LogItemsUnhide (void)
void	ReadSeverityMask (bool Unused)
	Set the Severity Mask, based on window buttons.
void	ReadModeMask (bool Unused)
	Set the Mode Mask, based on window buttons.
void	LogModeAll (void)
	Turn All Modes On.
void	LogModeNone (void)
	Turn All Modes Off.
void	LogSeverityAll (void)
	Turn All Severities On.
void	LogSeverityNone (void)
	Turn All Severities Off.

Private Member Functions
void	SaveLogSettings (void)
void	LoadLogSettings (void)
void	PresetLogSeverity (bool OnOff)
	Preset all of the Log Severity Levels.
void	PresetLogMode (bool OnOff)
	Preset all of the Modes.

Private Attributes
Ui::MainWindow *	ui
	Pointer the Main Program Window.
QStringList	severity_name_list
	This list holds the names of the valid severity levels.
QStringList	mode_name_list
	This list holds the names of the valid modes.
QStringList	icon_name_list
	This list holds the names of the severity level icons.
int	current_severity_mask
	Mask holding currently active severity levels.
int	current_mode_mask
	Mask holding currently active modes.
int	maximum_log_lines
	The maximum number of lines the log will retain.

Detailed Description

Definition at line 74 of file logger.h.

Constructor & Destructor Documentation

Logger()

Logger::Logger ( Ui::MainWindow * UI_Window )

explicit

The Log Constructor.

Parameters

UI_Window

The Program's main Window

Definition at line 3 of file logger.cpp.

{
    // Keep a Pointer to the Main Window
    ui = UI_Window;
 
    // Register Custom Meta Types for the "QObject::connect" Definitions
    qRegisterMetaType<REMOTE_LOG_ENTRY>("REMOTE_LOG_ENTRY");
 
    // Setup Severity Names
    severity_name_list << "EMERGENCY" << "ALERT"  << "CRITICAL" << "ERROR"
                       << "WARNING"   << "NOTICE" << "INFO"     << "DEBUG";
 
    // Setup Severity Icon List
    icon_name_list << ":/Resources/Emergency.png" << ":/Resources/Alert.png"  << ":/Resources/Critical.png" << ":/Resources/Error.png"
                   << ":/Resources/Warning.png"   << ":/Resources/Notice.png" << ":/Resources/Info.png"     << ":/Resources/Debug.png";
 
    // Setup Mode Names
    mode_name_list << "SIG_PROC" << "QT"    << "GENERAL" << "THREAD"  << "CONFIG"   << "TIMING"   << "SECURITY"  << "GRAPHICS"
                   << "MEMORY"   << "MATHS" << "FILE"    << "NETWORK" << "OPERATOR" << "DATABASE" << "EXCEPTION" << "SENSOR";
 
    current_severity_mask = ( 1 << (LOG_DEBUG   + 1 ) ) - 1;
    current_mode_mask     = ( 1 << (MODE_SENSOR + 1 ) ) - 1;
    maximum_log_lines     = DEFAULT_MAXIMUM_LOG_LINES;
 
    LoadLogSettings();
}

References current_mode_mask, current_severity_mask, DEFAULT_MAXIMUM_LOG_LINES, icon_name_list, LoadLogSettings(), LOG_DEBUG, maximum_log_lines, mode_name_list, MODE_SENSOR, severity_name_list, and ui.

Here is the call graph for this function:

~Logger()

Logger::~Logger

(

)

The Log Destructor.

Definition at line 30 of file logger.cpp.

{
    if (ui->LogSavOnExit->isChecked()) SaveLogSettings();
    severity_name_list.clear();
    icon_name_list.clear();
    mode_name_list.clear();
}

References icon_name_list, mode_name_list, SaveLogSettings(), severity_name_list, and ui.

Here is the call graph for this function:

Member Function Documentation

Add()

void Logger::Add	(	LOGGING_SEVERITY	Severity,
		LOGGING_MODE	Mode,
		const QString	LogMessage )

Add a Line to Log (in it matches the current settings)

Parameters

Severity	The Severtiry Level of the event being reported
Mode	The Logging Mode (event type) of the event being reported
LogMessage	Text message describing the event

If the Severity and Mode match the enable severity and mode in the log, this will be added to the log with a time stamp. If it does not meet these criteria, the line will be quietly ignored.

Definition at line 136 of file logger.cpp.

{
    // Check if the Log message will be added to the Log record based onthe Severity and Mode
    if ( ( ( current_severity_mask & (1 << Severity ) ) != 0 ) && ( ( current_mode_mask & (1 << Mode ) ) != 0 ) )
    {
        // Get the name of the severity icon, the name of the severity level, the name of the mode and the datetime of the entry
        // and place it into a ListWidget Item for inclusion in the Log
        QString icon_name     = icon_name_list.at( Severity );
        QString severity_name = severity_name_list.at( Severity );
        QString mode_name     = mode_name_list.at( Mode );
        QString entry_date    = QDateTime::currentDateTime().toString();
        QString log_entry     = "<" + entry_date + ">[" + severity_name + " : " + mode_name + " ] " +LogMessage;
        QListWidgetItem *item = new QListWidgetItem;
 
        // Put the Icon and Text into the Log Item and add to the Log
        item->setIcon( QIcon( icon_name ) );
        item->setText( log_entry );
        ui->LogView->addItem( item );
 
        // Remove Oldest Item While the Line Count Is Being Exceeded
        while ( ui->LogView->count() > maximum_log_lines )
        {
            ui->LogView->takeItem( 0 );
        }
    }
 
    // Flag the number of Entries in the Log to the Number of Log Lines Display
    emit CountChanged( ui->LogView->count() );
}

References CountChanged(), current_mode_mask, current_severity_mask, icon_name_list, maximum_log_lines, mode_name_list, severity_name_list, and ui.

Referenced by PresetLogMode(), PresetLogSeverity(), and RemoteLog().

Here is the call graph for this function:

Here is the caller graph for this function:

ClearLog

void Logger::ClearLog ( void )

privateslot

Clear the lines from the Log.

This routine will delete all of the lines that the log current holds.

Definition at line 53 of file logger.cpp.

{
    ui->LogView->clear();
    emit CountChanged( ui->LogView->count() );
}

References CountChanged(), and ui.

Referenced by LoadLogSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

CountChanged

void Logger::CountChanged ( int counter )

signal

A Signal to flag a change in the Number of Log Lines.

Parameters

counter

The new Number of Log Lines

When the number of log lones is increased (or decreased), this signal is fired so that the number of log lines display can be updated.

Referenced by Add(), ClearLog(), LoadLogSettings(), and SaveLog().

Here is the caller graph for this function:

LoadLogSettings()

void Logger::LoadLogSettings ( void )

private

Definition at line 166 of file logger.cpp.

{
    QSettings settings;
 
    ui->MaxLogLines->setValue(          settings.value( "Log_Setup/Allowed_lines", 500   ).toInt()  );
    ui->MaxLogLines->setMinimum(        settings.value( "Log_Setup/Minimum_lines", 20    ).toInt()  );
    ui->MaxLogLines->setMaximum(        settings.value( "Log_Setup/Maximum_lines", 20000 ).toInt()  );
 
    // Set the Connections
    QObject::connect( ui->ModeSelectAll,      SIGNAL( pressed( void ) ), this, SLOT( LogModeAll(      void ) ) );
    QObject::connect( ui->ModeClearAll,       SIGNAL( pressed( void ) ), this, SLOT( LogModeNone(     void ) ) );
    QObject::connect( ui->SeveritySelectAll,  SIGNAL( pressed( void ) ), this, SLOT( LogSeverityAll(  void ) ) );
    QObject::connect( ui->SeverityClearAll,   SIGNAL( pressed( void ) ), this, SLOT( LogSeverityNone( void ) ) );
    QObject::connect( ui->SaveLog,            SIGNAL( pressed( void ) ), this,  SLOT( SaveLog(         void ) ) );
    QObject::connect( ui->ClearLog,           SIGNAL( pressed( void ) ), this,  SLOT( ClearLog(        void ) ) );
    QObject::connect( ui->EmergencySelect,    SIGNAL( clicked( bool ) ), this, SLOT( ReadSeverityMask(  bool ) ) );
    QObject::connect( ui->AlertSelect,        SIGNAL( clicked( bool ) ), this, SLOT( ReadSeverityMask(  bool ) ) );
    QObject::connect( ui->CriticalSelect,     SIGNAL( clicked( bool ) ), this, SLOT( ReadSeverityMask(  bool ) ) );
    QObject::connect( ui->ErrorSelect,        SIGNAL( clicked( bool ) ), this, SLOT( ReadSeverityMask(  bool ) ) );
    QObject::connect( ui->WarningSelect,      SIGNAL( clicked( bool ) ), this, SLOT( ReadSeverityMask(  bool ) ) );
    QObject::connect( ui->NoticeSelect,       SIGNAL( clicked( bool ) ), this, SLOT( ReadSeverityMask(  bool ) ) );
    QObject::connect( ui->InfoSelect,         SIGNAL( clicked( bool ) ), this, SLOT( ReadSeverityMask(  bool ) ) );
    QObject::connect( ui->DebugSelect,        SIGNAL( clicked( bool ) ), this, SLOT( ReadSeverityMask(  bool ) ) );
    QObject::connect( ui->SigProcessSelect,   SIGNAL( clicked( bool ) ), this, SLOT( ReadModeMask(      bool ) ) );
    QObject::connect( ui->QtSelect,           SIGNAL( clicked( bool ) ), this, SLOT( ReadModeMask(      bool ) ) );
    QObject::connect( ui->GeneralSelect,      SIGNAL( clicked( bool ) ), this, SLOT( ReadModeMask(      bool ) ) );
    QObject::connect( ui->ThreadSelect,       SIGNAL( clicked( bool ) ), this, SLOT( ReadModeMask(      bool ) ) );
    QObject::connect( ui->ConfigSelect,       SIGNAL( clicked( bool ) ), this, SLOT( ReadModeMask(      bool ) ) );
    QObject::connect( ui->TimingSelect,       SIGNAL( clicked( bool ) ), this, SLOT( ReadModeMask(      bool ) ) );
    QObject::connect( ui->SecuritySelect,     SIGNAL( clicked( bool ) ), this, SLOT( ReadModeMask(      bool ) ) );
    QObject::connect( ui->GraphicsSelect,     SIGNAL( clicked( bool ) ), this, SLOT( ReadModeMask(      bool ) ) );
    QObject::connect( ui->MemorySelect,       SIGNAL( clicked( bool ) ), this, SLOT( ReadModeMask(      bool ) ) );
    QObject::connect( ui->MathsSelect,        SIGNAL( clicked( bool ) ), this, SLOT( ReadModeMask(      bool ) ) );
    QObject::connect( ui->FileOpsSelect,      SIGNAL( clicked( bool ) ), this, SLOT( ReadModeMask(      bool ) ) );
    QObject::connect( ui->NetworkCommsSelect, SIGNAL( clicked( bool ) ), this, SLOT( ReadModeMask(      bool ) ) );
    QObject::connect( ui->OperatorSelect,     SIGNAL( clicked( bool ) ), this, SLOT( ReadModeMask(      bool ) ) );
    QObject::connect( ui->DatabaseSelect,     SIGNAL( clicked( bool ) ), this, SLOT( ReadModeMask(      bool ) ) );
    QObject::connect( ui->ExceptionsSelect,   SIGNAL( clicked( bool ) ), this, SLOT( ReadModeMask(      bool ) ) );
    QObject::connect( ui->SensorsSelect,      SIGNAL( clicked( bool ) ), this, SLOT( ReadModeMask(      bool ) ) );
    QObject::connect( this,                   SIGNAL( CountChanged( int ) ), ui->LogLineCounter, SLOT( display( int ) ) );
    QObject::connect( ui->LogView,            SIGNAL( itemClicked( QListWidgetItem * ) ), this, SLOT( LogSelectItem( QListWidgetItem * ) ) );
    QObject::connect( ui->AllUnhideLog,       SIGNAL( pressed( void) ), this, SLOT( LogItemsUnhide( void ) ) );
    QObject::connect( ui->MaxLogLines,        SIGNAL( valueChanged( int) ), this, SLOT( UpdateMaxLogLines( int ) ) );
 
    ui->EmergencySelect->setChecked( settings.value( "Log_Severity/Emergency",     true  ).toBool() );
    ui->AlertSelect->setChecked(     settings.value( "Log_Severity/Alert",         true  ).toBool() );
    ui->CriticalSelect->setChecked(  settings.value( "Log_Severity/Critical",      true  ).toBool() );
    ui->ErrorSelect->setChecked(     settings.value( "Log_Severity/Error",         true  ).toBool() );
    ui->WarningSelect->setChecked(   settings.value( "Log_Severity/Warning",       true ).toBool() );
    ui->NoticeSelect->setChecked(    settings.value( "Log_Severity/Notice",        true ).toBool() );
    ui->InfoSelect->setChecked(      settings.value( "Log_Severity/Info",          true ).toBool() );
    ui->DebugSelect->setChecked(     settings.value( "Log_Severity/Debug",         true ).toBool() );
    ReadSeverityMask( true );
 
    // Load the Mode Settings
    ui->SigProcessSelect->setChecked(   settings.value( "Log_Mode/SigProc",        true  ).toBool() );
    ui->QtSelect->setChecked(           settings.value( "Log_Mode/Qt",             true  ).toBool() );
    ui->GeneralSelect->setChecked(      settings.value( "Log_Mode/General",        true  ).toBool() );
    ui->ThreadSelect->setChecked(       settings.value( "Log_Mode/Thread",         true  ).toBool() );
    ui->ConfigSelect->setChecked(       settings.value( "Log_Mode/Configuration",  true  ).toBool() );
    ui->TimingSelect->setChecked(       settings.value( "Log_Mode/Timing",         true  ).toBool() );
    ui->SecuritySelect->setChecked(     settings.value( "Log_Mode/Security",       true  ).toBool() );
    ui->GraphicsSelect->setChecked(     settings.value( "Log_Mode/Graphics",       true  ).toBool() );
    ui->MemorySelect->setChecked(       settings.value( "Log_Mode/Memory",         true  ).toBool() );
    ui->MathsSelect->setChecked(        settings.value( "Log_Mode/Maths",          true  ).toBool() );
    ui->FileOpsSelect->setChecked(      settings.value( "Log_Mode/File",           true  ).toBool() );
    ui->NetworkCommsSelect->setChecked( settings.value( "Log_Mode/Network",        true  ).toBool() );
    ui->OperatorSelect->setChecked(     settings.value( "Log_Mode/Operator",       true  ).toBool() );
    ui->DatabaseSelect->setChecked(     settings.value( "Log_Mode/Database",       true  ).toBool() );
    ui->ExceptionsSelect->setChecked(   settings.value( "Log_Mode/Exception",      true  ).toBool() );
    ui->SensorsSelect->setChecked(      settings.value( "Log_Mode/Sensors",        true  ).toBool() );
    ReadModeMask( true );
}

References ClearLog(), CountChanged(), LogItemsUnhide(), LogModeAll(), LogModeNone(), LogSelectItem(), LogSeverityAll(), LogSeverityNone(), ReadModeMask(), ReadSeverityMask(), SaveLog(), ui, and UpdateMaxLogLines().

Referenced by Logger().

Here is the call graph for this function:

Here is the caller graph for this function:

LogItemsUnhide

void Logger::LogItemsUnhide ( void )

privateslot

Definition at line 497 of file logger.cpp.

{
    for ( int row = 0; row < ui->LogView->count(); ++row )
    {
        QListWidgetItem *item = ui->LogView->item( row );
        if ( item != nullptr )
        {
            item->setHidden( false );
        }
    }
}

References ui.

Referenced by LoadLogSettings().

Here is the caller graph for this function:

LogModeAll

void Logger::LogModeAll ( void )

privateslot

Turn All Modes On.

This routine turns all Modes on to make it easy to set the active modes without checking a lot of check boxes.

Definition at line 477 of file logger.cpp.

{
    PresetLogMode( true );
}

References PresetLogMode().

Referenced by LoadLogSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

LogModeNone

void Logger::LogModeNone ( void )

privateslot

Turn All Modes Off.

This routine turns all Modes off to make it easy to reset the active modes without checking a lot of check boxes.

Definition at line 482 of file logger.cpp.

{
    PresetLogMode( false );
}

References PresetLogMode().

Referenced by LoadLogSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

LogSelectItem

void Logger::LogSelectItem ( QListWidgetItem * Item )

privateslot

Definition at line 468 of file logger.cpp.

{
    // If Hidden Selected, Hide the Log Line
    if ( ui->HideSelectedLog->isChecked() )
    {
        Item->setHidden( true );
    }
}

References ui.

Referenced by LoadLogSettings().

Here is the caller graph for this function:

LogSeverityAll

void Logger::LogSeverityAll ( void )

privateslot

Turn All Severities On.

This routine turns all Severities on to make it easy to set the active Severities without checking a lot of check boxes.

Definition at line 487 of file logger.cpp.

{
    PresetLogSeverity( true );
}

References PresetLogSeverity().

Referenced by LoadLogSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

LogSeverityNone

void Logger::LogSeverityNone ( void )

privateslot

Turn All Severities Off.

This routine turns all Severities off to make it easy to reset the active Severities without checking a lot of check boxes.

Definition at line 492 of file logger.cpp.

{
    PresetLogSeverity( false );
}

References PresetLogSeverity().

Referenced by LoadLogSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

PresetLogMode()

void Logger::PresetLogMode ( bool OnOff )

private

Preset all of the Modes.

Parameters

OnOff

If OnOff is On, all modes will be set, otherwise, all will be reset.

Definition at line 106 of file logger.cpp.

{
    ui->SigProcessSelect->setChecked(   OnOff );
    ui->QtSelect->setChecked(           OnOff );
    ui->GeneralSelect->setChecked(      OnOff );
    ui->ThreadSelect->setChecked(       OnOff );
    ui->ConfigSelect->setChecked(       OnOff );
    ui->TimingSelect->setChecked(       OnOff );
    ui->SecuritySelect->setChecked(     OnOff );
    ui->GraphicsSelect->setChecked(     OnOff );
    ui->MemorySelect->setChecked(       OnOff );
    ui->MathsSelect->setChecked(        OnOff );
    ui->FileOpsSelect ->setChecked(     OnOff );
    ui->NetworkCommsSelect->setChecked( OnOff );
    ui->OperatorSelect->setChecked(     OnOff );
    ui->DatabaseSelect->setChecked(     OnOff );
    ui->ExceptionsSelect->setChecked(   OnOff );
    ui->SensorsSelect->setChecked(      OnOff );
    SaveModeMask( true );
 
    if ( OnOff )
    {
        Add( LOG_DEBUG, MODE_OPERATOR, "All Mode Check Boxes Enabled" );
    }
    else
    {
        Add( LOG_DEBUG, MODE_OPERATOR, "All Mode Check Boxes Disabled" );
    }
}

References Add(), LOG_DEBUG, MODE_OPERATOR, SaveModeMask(), and ui.

Referenced by LogModeAll(), and LogModeNone().

Here is the call graph for this function:

Here is the caller graph for this function:

PresetLogSeverity()

void Logger::PresetLogSeverity ( bool OnOff )

private

Preset all of the Log Severity Levels.

Parameters

OnOff

If OnOff is On, all severity levels will be set, otherwise, all will be reset.

Definition at line 84 of file logger.cpp.

{
    ui->EmergencySelect->setChecked( OnOff );
    ui->AlertSelect->setChecked(     OnOff );
    ui->DebugSelect->setChecked(     OnOff );
    ui->ErrorSelect->setChecked(     OnOff );
    ui->NoticeSelect->setChecked(    OnOff );
    ui->WarningSelect->setChecked(   OnOff );
    ui->CriticalSelect->setChecked(  OnOff );
    ui->InfoSelect->setChecked(      OnOff );
    SaveSeverityMask( true );
 
    if ( OnOff )
    {
        Add( LOG_DEBUG, MODE_OPERATOR, "All Severity Check Boxes Enabled" );
    }
    else
    {
        Add( LOG_DEBUG, MODE_OPERATOR, "All Severity Check Boxes Disabled" );
    }
}

References Add(), LOG_DEBUG, MODE_OPERATOR, SaveSeverityMask(), and ui.

Referenced by LogSeverityAll(), and LogSeverityNone().

Here is the call graph for this function:

Here is the caller graph for this function:

ReadModeMask

void Logger::ReadModeMask ( bool Unused )

privateslot

Set the Mode Mask, based on window buttons.

Parameters

Unused

parameter for Signal, Slot parameter matching

This routine will look at the state of the Mode buttons associated with the logger and sets the bits in the serverity mask corresponding to the set buttons.

Definition at line 319 of file logger.cpp.

{
    int mode_mask = 0;
 
    if ( ui->SigProcessSelect->isChecked() )
    {
        mode_mask |= 1 << MODE_SIG_PROC;
    }
    else
    {
        mode_mask &= ~(1 << MODE_SIG_PROC);
    }
    if ( ui->QtSelect->isChecked() )
    {
        mode_mask |= 1 << MODE_QT;
    }
    else
    {
        mode_mask &= ~(1 << MODE_QT);
    }
 
    if ( ui->GeneralSelect->isChecked() )
    {
        mode_mask |= 1 << MODE_GENERAL;
    }
    else
    {
        mode_mask &= ~(1 << MODE_GENERAL);
    }
 
    if ( ui->ThreadSelect->isChecked() )
    {
        mode_mask |= 1 << MODE_THREAD;
    }
    else
    {
        mode_mask &= ~(1 << MODE_THREAD);
    }
 
    if ( ui->ConfigSelect->isChecked() )
    {
        mode_mask |= 1 << MODE_CONFIG;
    }
    else
    {
        mode_mask &= ~(1 << MODE_CONFIG);
    }
 
    if ( ui->TimingSelect->isChecked() )
    {
        mode_mask |= 1 << MODE_TIMING;
    }
    else
    {
        mode_mask &= ~(1 << MODE_TIMING);
    }
 
    if ( ui->SecuritySelect->isChecked() )
    {
        mode_mask |= 1 << MODE_SECURITY;
    }
    else
    {
        mode_mask &= ~(1 << MODE_SECURITY);
    }
 
    if ( ui->GraphicsSelect->isChecked() )
    {
        mode_mask |= 1 << MODE_GRAPHICS;
    }
    else
    {
        mode_mask &= ~(1 << MODE_GRAPHICS);
    }
 
    if ( ui->MemorySelect->isChecked() )
    {
        mode_mask |= 1 << MODE_MEMORY;
    }
    else
    {
        mode_mask &= ~(1 << MODE_MEMORY);
    }
 
    if ( ui->MathsSelect->isChecked() )
    {
        mode_mask |= 1 << MODE_MATHS;
    }
    else
    {
        mode_mask &= ~(1 << MODE_MATHS);
    }
 
    if ( ui->FileOpsSelect->isChecked() )
    {
        mode_mask |= 1 << MODE_FILE;
    }
    else
    {
        mode_mask &= ~(1 << MODE_FILE);
    }
 
    if ( ui->NetworkCommsSelect->isChecked() )
    {
        mode_mask |= 1 << MODE_NETWORK;
    }
    else
    {
        mode_mask &= ~(1 << MODE_NETWORK);
    }
 
    if ( ui->OperatorSelect->isChecked() )
    {
        mode_mask |= 1 << MODE_OPERATOR;
    }
    else
    {
        mode_mask &= ~(1 << MODE_OPERATOR);
    }
 
    if ( ui->DatabaseSelect->isChecked() )
    {
        mode_mask |= 1 << MODE_DATABASE;
    }
    else
    {
        mode_mask &= ~(1 << MODE_DATABASE);
    }
 
    if ( ui->ExceptionsSelect->isChecked() )
    {
        mode_mask |= 1 << MODE_EXCEPTION;
    }
    else
    {
        mode_mask &= ~(1 << MODE_EXCEPTION);
    }
 
    if ( ui->SensorsSelect->isChecked() )
    {
        mode_mask |= 1 << MODE_SENSOR;
    }
    else
    {
        mode_mask &= ~(1 << MODE_SENSOR);
    }
    SaveModeMask( mode_mask );
}

References MODE_CONFIG, MODE_DATABASE, MODE_EXCEPTION, MODE_FILE, MODE_GENERAL, MODE_GRAPHICS, MODE_MATHS, MODE_MEMORY, MODE_NETWORK, MODE_OPERATOR, MODE_QT, MODE_SECURITY, MODE_SENSOR, MODE_SIG_PROC, MODE_THREAD, MODE_TIMING, SaveModeMask(), and ui.

Referenced by LoadLogSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

ReadSeverityMask

void Logger::ReadSeverityMask ( bool Unused )

privateslot

Set the Severity Mask, based on window buttons.

Parameters

Unused

parameter for Signal, Slot parameter matching

This routine will look at the state of the Serverity buttons associated with the logger and sets the bits in the serverity mask corresponding to the set buttons.

Definition at line 241 of file logger.cpp.

{
    int severity_mask = 0;
 
    if ( ui->EmergencySelect->isChecked() )
    {
        severity_mask |= 1 << LOG_EMERGENCY;
    }
    else
    {
        severity_mask &= ~(1 << LOG_EMERGENCY);
    }
 
    if ( ui->AlertSelect->isChecked() )
    {
        severity_mask |= 1 << LOG_ALERT;
    }
    else
    {
        severity_mask &= ~(1 << LOG_ALERT);
    }
 
    if ( ui->CriticalSelect->isChecked() )
    {
        severity_mask |= 1 << LOG_CRITICAL;
    }
    else
    {
        severity_mask &= ~(1 << LOG_CRITICAL);
    }
 
    if ( ui->ErrorSelect->isChecked() )
    {
        severity_mask |= 1 << LOG_ERROR;
    }
    else
    {
        severity_mask &= ~(1 << LOG_ERROR);
    }
 
    if ( ui->WarningSelect->isChecked() )
    {
        severity_mask |= 1 << LOG_WARNING;
    }
    else
    {
        severity_mask &= ~(1 << LOG_WARNING);
    }
 
    if ( ui->NoticeSelect->isChecked() )
    {
        severity_mask |= 1 << LOG_NOTICE;
    }
    else
    {
        severity_mask &= ~(1 << LOG_NOTICE);
    }
 
    if ( ui->InfoSelect->isChecked() )
    {
        severity_mask |= 1 << LOG_INFO;
    }
    else
    {
        severity_mask &= ~(1 << LOG_INFO);
    }
 
    if ( ui->DebugSelect->isChecked() )
    {
        severity_mask |= 1 << LOG_DEBUG;
    }
    else
    {
        severity_mask &= ~(1 << LOG_DEBUG);
    }
    SaveSeverityMask( severity_mask );
}

References LOG_ALERT, LOG_CRITICAL, LOG_DEBUG, LOG_EMERGENCY, LOG_ERROR, LOG_INFO, LOG_NOTICE, LOG_WARNING, SaveSeverityMask(), and ui.

Referenced by LoadLogSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

RemoteLog

void Logger::RemoteLog ( REMOTE_LOG_ENTRY LogEntry )

slot

Receiver a Log Entry via a Public Slot.

Parameters

LogEntry

Structure holding the Log Entry

Definition at line 553 of file logger.cpp.

{
    Add( LogEntry.Severity, LogEntry.Mode, LogEntry.Message );
}

References Add(), REMOTE_LOG_ENTRY::Message, REMOTE_LOG_ENTRY::Mode, and REMOTE_LOG_ENTRY::Severity.

Here is the call graph for this function:

SaveLog

void Logger::SaveLog ( void )

privateslot

Save the Log Lines to a File.

This routine takes the lines in the log and writes them to a file.

Definition at line 59 of file logger.cpp.

{
    // Ask the User for the Name of the File to hold the Log Entries
    QString filename = QFileDialog::getSaveFileName( nullptr, "Save Filename", "LogFile.txt", "Files (*.txt )" );
 
    // If A Filename was provided, write out the log lines, then clear the display.
    if ( filename != "" )
    {
        // Write to the File
        QFile file( filename );
        if (file.open(QIODevice::WriteOnly | QIODevice::Text))
        {
            int row_counter = 0;
            QTextStream out(&file);
            while( row_counter < ui->LogView->count() )
            {
                out << ui->LogView->item( row_counter++ )->text() << "\n";
            }
        }
        file.close();
        ui->LogView->clear();
    }
    emit CountChanged( ui->LogView->count() );
}

References CountChanged(), and ui.

Referenced by LoadLogSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

SaveLogSettings()

void Logger::SaveLogSettings ( void )

private

Definition at line 514 of file logger.cpp.

{
    QSettings settings;
 
    // Save the Log Severity Settings
    settings.setValue( "Log_Severity/Emergency", ui->EmergencySelect->isChecked()    );
    settings.setValue( "Log_Severity/Alert",     ui->AlertSelect->isChecked()        );
    settings.setValue( "Log_Severity/Critical",  ui->CriticalSelect->isChecked()     );
    settings.setValue( "Log_Severity/Error",     ui->ErrorSelect->isChecked()        );
    settings.setValue( "Log_Severity/Warning",   ui->WarningSelect->isChecked()      );
    settings.setValue( "Log_Severity/Notice",    ui->NoticeSelect->isChecked()       );
    settings.setValue( "Log_Severity/Info",      ui->InfoSelect->isChecked()         );
    settings.setValue( "Log_Severity/Debug",     ui->DebugSelect->isChecked()        );
 
 
    // Save the Mode Settings
    settings.setValue( "Log_Mode/SigProc",       ui->SigProcessSelect->isChecked()   );
    settings.setValue( "Log_Mode/Qt",            ui->QtSelect->isChecked()           );
    settings.setValue( "Log_Mode/General",       ui->GeneralSelect->isChecked()      );
    settings.setValue( "Log_Mode/Thread",        ui->ThreadSelect->isChecked()       );
    settings.setValue( "Log_Mode/Configuration", ui->ConfigSelect->isChecked()       );
    settings.setValue( "Log_Mode/Timing",        ui->TimingSelect->isChecked()       );
    settings.setValue( "Log_Mode/Security",      ui->SecuritySelect->isChecked()     );
    settings.setValue( "Log_Mode/Graphics",      ui->GraphicsSelect->isChecked()     );
    settings.setValue( "Log_Mode/Memory",        ui->MemorySelect->isChecked()       );
    settings.setValue( "Log_Mode/Maths",         ui->MathsSelect->isChecked()        );
    settings.setValue( "Log_Mode/File",          ui->FileOpsSelect->isChecked()      );
    settings.setValue( "Log_Mode/Network",       ui->NetworkCommsSelect->isChecked() );
    settings.setValue( "Log_Mode/Operator",      ui->OperatorSelect->isChecked()     );
    settings.setValue( "Log_Mode/Database",      ui->DatabaseSelect->isChecked()     );
    settings.setValue( "Log_Mode/Exception",     ui->ExceptionsSelect->isChecked()   );
    settings.setValue( "Log_Mode/Sensors",       ui->SensorsSelect->isChecked()      );
 
    // Save Log Parameters
    settings.setValue( "Log_Setup/Allowed_lines", ui->MaxLogLines->value()           );
    settings.setValue( "Log_Setup/Minimum_lines", ui->MaxLogLines->minimum()         );
    settings.setValue( "Log_Setup/Maximum_lines", ui->MaxLogLines->maximum()         );
}

References ui.

Referenced by ~Logger().

Here is the caller graph for this function:

SaveModeMask()

void Logger::SaveModeMask

(

int

ModeMask

)

Save the Log Mode Mask.

Parameters

ModeMask

A mask of the active modes

The SeverityMask holds each possible mode as a bit mask. If a bit is on, then that mode is active.

Definition at line 43 of file logger.cpp.

{
    current_mode_mask = ModeMask;
}

References current_mode_mask.

Referenced by PresetLogMode(), and ReadModeMask().

Here is the caller graph for this function:

SaveSeverityMask()

void Logger::SaveSeverityMask

(

int

SeverityMask

)

Save the Log Severity Mask.

Parameters

SeverityMask

A mask of the active severity levels

The SeverityMask holds each possible severity level as a bit mask. If a bit is on, then that severity level is active.

Definition at line 38 of file logger.cpp.

{
    current_severity_mask = SeverityMask;
}

References current_severity_mask.

Referenced by PresetLogSeverity(), and ReadSeverityMask().

Here is the caller graph for this function:

SetMaxLines()

void Logger::SetMaxLines

(

int

MaxLogLines

)

Set the maximum number of lines the log will retain.

Parameters

MaxLogLines

Maximum log lines to retain

This function sets the maximum number of lines the log will retain before the oldest lines are delted when a new log line arrives.

Definition at line 48 of file logger.cpp.

{
    maximum_log_lines = MaxLogLines;
}

References maximum_log_lines.

Referenced by UpdateMaxLogLines().

Here is the caller graph for this function:

UpdateMaxLogLines

void Logger::UpdateMaxLogLines ( int Value )

privateslot

Definition at line 509 of file logger.cpp.

{
    SetMaxLines( Value );
}

References SetMaxLines().

Referenced by LoadLogSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

current_mode_mask

int Logger::current_mode_mask

private

Mask holding currently active modes.

Each mode is represented by a bit in the mask. If that bit is not a 1, then a log message with that mode will be rejected.

Definition at line 220 of file logger.h.

Referenced by Add(), Logger(), and SaveModeMask().

current_severity_mask

int Logger::current_severity_mask

private

Mask holding currently active severity levels.

Each severity level is represented by a bit in the mask. If that bit is not a 1, then a log message with that level will be rejected.

Definition at line 212 of file logger.h.

Referenced by Add(), Logger(), and SaveSeverityMask().

icon_name_list

QStringList Logger::icon_name_list

private

This list holds the names of the severity level icons.

These icons are attached to the log lines that are placed in the log. The colour is an indication of the severity level of the log line. The icon colours range from deep green for Debug, through to deep red for a fatal error.

Definition at line 204 of file logger.h.

Referenced by Add(), Logger(), and ~Logger().

maximum_log_lines

int Logger::maximum_log_lines

private

The maximum number of lines the log will retain.

Definition at line 226 of file logger.h.

Referenced by Add(), Logger(), and SetMaxLines().

mode_name_list

QStringList Logger::mode_name_list

private

This list holds the names of the valid modes.

Definition at line 195 of file logger.h.

Referenced by Add(), Logger(), and ~Logger().

severity_name_list

QStringList Logger::severity_name_list

private

This list holds the names of the valid severity levels.

Definition at line 189 of file logger.h.

Referenced by Add(), Logger(), and ~Logger().

ui

Ui::MainWindow* Logger::ui

private

Pointer the Main Program Window.

This is used to access all the graphical objects on the display.

Definition at line 183 of file logger.h.

Referenced by Add(), ClearLog(), LoadLogSettings(), Logger(), LogItemsUnhide(), LogSelectItem(), PresetLogMode(), PresetLogSeverity(), ReadModeMask(), ReadSeverityMask(), SaveLog(), SaveLogSettings(), and ~Logger().

---

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

• logger.h
• logger.cpp