ProgramIdentification Class Reference

Program Identification Class. More...

#include <programidentification.h>

Inheritance diagram for ProgramIdentification:

Collaboration diagram for ProgramIdentification:

Signals
void	SendLogEntry (REMOTE_LOG_ENTRY LogEntry)
void	SendVersionString (QString FullVersion)
	Sent the Version Information.

Public Member Functions
	ProgramIdentification (Ui::MainWindow *UI_Window)
void	LoadProgramIdentification ()
	Load Program Identification Information.

Private Member Functions
void	LogAdd (LOGGING_SEVERITY Severity, LOGGING_MODE Mode, QString Message)
	Add a Log Entry.

Private Attributes
Ui::MainWindow *	ui
QStringList	image_list
	A list of the images used by the program.
QString	project_prefix
	String holding the Project Ident Prefix.
uint	suffix_size
	Number of digits in the Project ident.

Detailed Description

Program Identification Class.

Definition at line 21 of file programidentification.h.

Constructor & Destructor Documentation

ProgramIdentification()

ProgramIdentification::ProgramIdentification ( Ui::MainWindow * UI_Window )

explicit

Definition at line 11 of file programidentification.cpp.

{
    ui = UI_Window;
}

References ui.

Member Function Documentation

LoadProgramIdentification()

void ProgramIdentification::LoadProgramIdentification

(

)

Load Program Identification Information.

Definition at line 16 of file programidentification.cpp.

{
    ui->ProgramIdentificationCode->setText(PROJECT_IDENTIFIER);
    ui->ProgramVersion->setText(VERSION_STRING);
    ui->Compiler->setText("Qt");
    ui->ProgramBuildDate->setText(QStringLiteral(__DATE__) + QStringLiteral(" ") + QStringLiteral(__TIME__));
    ui->CompilerVersion->setText(QT_VERSION_STR);
    ui->ContactName->setText(CONTACT_NAME);
    ui->ContactEmail->setText(CONTACT_EMAIL);
    ui->ProgramWebsite->setText(PROJECT_WEBSITE);
    ui->SoftwareLicence->setText(PROGRAM_SOFTWARE_LICENCE);
    ui->DocumentationLicence->setText(PROGRAM_DOCUMENTATION_LICENCE);
    ui->HardwareLicence->setText(PROGRAM_HARDWARE_LICENCE);
    ui->CopyrightStatement->setText(COPYRIGHT_STATEMENT);
    LogAdd(LOG_DEBUG, MODE_CONFIG, "Program's Build Information Loaded.");
 
    ui->SystemArchitecture->setText(QSysInfo::currentCpuArchitecture());
    ui->OpSysProductName->setText(QSysInfo::prettyProductName());
    ui->OpSysVersion->setText(QSysInfo::productVersion());
    ui->NodeName->setText(QSysInfo::machineHostName());
    QString qt_version;
    qt_version.fromLocal8Bit(qVersion());
    ui->BuildProgram->setText(qt_version);
    ui->ProgramBuildDate->setText(QStringLiteral(__DATE__) + QStringLiteral(" ") + QStringLiteral(__TIME__));
    LogAdd(LOG_DEBUG, MODE_CONFIG, "Program's System Information Loaded.");
 
    // Create List of Images to Display on Identification tab
    image_list << "Brigadoon_Logo.bmp" << "Built_with_Qt_RGB_logo_vertical.png";
    QString os_type = QSysInfo::kernelType().toLower();
    if (os_type == "linux") image_list << "linux_dual.jpg"; else if (os_type == "winnt") image_list << "windows_logo.png";
    image_list << "git.png" << "doxygen_logo.jpg" << "md5deep.png" << "dia_logo.jpg" << "plantuml.png" << "graphviz.png" << "cppcheck.png" << "Files-Tar-icon.png" << "Cloc.png" << "Mariadb.png";
 
    // Define a Grid Layout
    QGridLayout* image_layout = new QGridLayout(ui->ProgramImageLayout);
    int row = 0; int column = 0;
 
    int list_size = image_list.size();
 
    if (list_size > 0)
    {
        // Iterate Through the Image List
        for (int index = 0; index < list_size; index++)
        {
            QPixmap the_pixmap( QString(":/Resources/") + image_list[index] );
            QLabel* the_image = new QLabel();
            the_image->setPixmap(the_pixmap.scaledToWidth(140));
            image_layout->addWidget(the_image, row++, column, 1, 1, Qt::AlignCenter);
            if ( row > 2){ row = 0; column++; }
        }
    }
    LogAdd(LOG_DEBUG, MODE_CONFIG, "Program's Acknowledgement Images Loaded.");
}

References CONTACT_EMAIL, CONTACT_NAME, COPYRIGHT_STATEMENT, image_list, LOG_DEBUG, LogAdd(), MODE_CONFIG, PROGRAM_DOCUMENTATION_LICENCE, PROGRAM_HARDWARE_LICENCE, PROGRAM_SOFTWARE_LICENCE, PROJECT_IDENTIFIER, PROJECT_WEBSITE, ui, and VERSION_STRING.

Here is the call graph for this function:

LogAdd()

void ProgramIdentification::LogAdd ( LOGGING_SEVERITY Severity, LOGGING_MODE Mode, QString Message )

private

Add a Log Entry.

Parameters

Severity	Severity of the Logged Event
Mode	Part of the Program being Logged
Message	Description of the Log Event

Definition at line 69 of file programidentification.cpp.

{
    REMOTE_LOG_ENTRY log_entry;
    log_entry.Severity = Severity;
    log_entry.Mode = Mode;
    log_entry.Message = Message;
    emit SendLogEntry(log_entry);
}

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

Referenced by LoadProgramIdentification().

Here is the call graph for this function:

Here is the caller graph for this function:

SendLogEntry

void ProgramIdentification::SendLogEntry ( REMOTE_LOG_ENTRY LogEntry )

signal

Referenced by LogAdd().

Here is the caller graph for this function:

SendVersionString

void ProgramIdentification::SendVersionString ( QString FullVersion )

signal

Sent the Version Information.

Field Documentation

image_list

QStringList ProgramIdentification::image_list

private

A list of the images used by the program.

Definition at line 62 of file programidentification.h.

Referenced by LoadProgramIdentification().

project_prefix

QString ProgramIdentification::project_prefix

private

String holding the Project Ident Prefix.

Definition at line 68 of file programidentification.h.

suffix_size

uint ProgramIdentification::suffix_size

private

Number of digits in the Project ident.

Definition at line 74 of file programidentification.h.

ui

Ui::MainWindow* ProgramIdentification::ui

private

brief Pointer to the main window

Definition at line 56 of file programidentification.h.

Referenced by LoadProgramIdentification(), and ProgramIdentification().

---

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

• programidentification.h
• programidentification.cpp