DatabaseManager Class Reference

Class to control the opening of the Database. More...

#include <databasemanager.h>

Inheritance diagram for DatabaseManager:

Collaboration diagram for DatabaseManager:

Public Slots
void	ReconnectDatabase (void)
	Reconnect to the databse using the current parameters.
void	LoadDefaultDBParameters (void)
	Load the default Database Paranmeters.

Signals
void	SendLogEntry (REMOTE_LOG_ENTRY LogEntry)
	Send Log Entry via the Signal-Slot Method.

Public Member Functions
	DatabaseManager (Ui::MainWindow *UI_Window)
	Database Class Constructor.
	~DatabaseManager ()
	Database Manager Deconstructor.

Private Member Functions
void	LoadDatabaseDrivers (QComboBox *DriverList)
	Load the know Database Drivers.
bool	Open (void)
	Open the Database witht selected parameters.
void	RemoveDatabase (void)
	Remove the current active database.
bool	CheckIfOpen (bool IsOpen)
	Set the Database Image based on IsOpenFlag.
void	LogAdd (LOGGING_SEVERITY Severity, LOGGING_MODE Mode, QString Message)
	Send Message to the Log.

Private Attributes
Ui::MainWindow *	ui
	Pointer to the Main Window.
bool	is_database
	Flag to indicate if there is a database.
bool	is_open
	Flag to indicate if database is open.

Detailed Description

Class to control the opening of the Database.

Definition at line 18 of file databasemanager.h.

Constructor & Destructor Documentation

DatabaseManager()

DatabaseManager::DatabaseManager ( Ui::MainWindow * UI_Window )

explicit

Database Class Constructor.

Parameters

UI_Window

The Program's main Window

Definition at line 7 of file databasemanager.cpp.

{
    // Save the Pointer to the Main Window & Pointer to Log
    ui = UI_Window;
 
    // Flag that there is no Current Database
    is_database = false;
    is_open = false;
 
    // Load the Availalbe Database Drivers
    LoadDatabaseDrivers(ui->DatabaseDriver);
 
    // Load the Default Dataabse Parameters
    LoadDefaultDBParameters();
 
    // Define the Connections
    QObject::connect(ui->ReconnectDatabase, SIGNAL(pressed()), this, SLOT(ReconnectDatabase()));
    QObject::connect(ui->LoadDefaultDBParams, SIGNAL(pressed()), this, SLOT(LoadDefaultDBParameters()));
}

References is_database, is_open, LoadDatabaseDrivers(), LoadDefaultDBParameters(), ReconnectDatabase(), and ui.

Here is the call graph for this function:

~DatabaseManager()

DatabaseManager::~DatabaseManager

(

)

Database Manager Deconstructor.

Definition at line 27 of file databasemanager.cpp.

{
    // Remove Database, if it Exists
    RemoveDatabase();
 
    // Save the Database Settings, If Required
    if (ui->SaveDBParamsOnExit->isChecked())
    {
 
        QSettings settings;
        settings.setValue( "Database/DatabaseName", ui->DatabaseName->text());
        settings.setValue( "Database/DatabaseHost", ui->DatabaseHost->text());
        settings.setValue( "Database/DatabaseUser", ui->DatabaseUsername->text());
        settings.setValue( "Database/DatabasePassword", ui->DatabasePassword->text());
        settings.setValue( "Database/DatabaseDriver", ui->DatabaseDriver->currentText());
    }
}

References RemoveDatabase(), and ui.

Here is the call graph for this function:

Member Function Documentation

CheckIfOpen()

bool DatabaseManager::CheckIfOpen ( bool IsOpen )

private

Set the Database Image based on IsOpenFlag.

Returns

Return the value of IsOpen

If the database is open, the database state image is set to green. If the database is closed, the databse state images is set to ref.

Definition at line 116 of file databasemanager.cpp.

{
    QString selected_image;
 
    // Set the Database Open Graphic As Appropriate & Send a Log Message
    if (DatabaseOpen)
    {
        selected_image = "Debug.png";
        LogAdd(LOG_DEBUG, MODE_DATABASE, QString("Database %1 is OPEN.").arg(ui->DatabaseName->text()));
    }
    else
    {
        selected_image = "Alert.png";
        LogAdd(LOG_WARNING, MODE_DATABASE, QString("Database %1 is NOT OPEN.").arg(ui->DatabaseName->text()));
    }
    QPixmap the_pixmap( QString(":/Resources/") + selected_image );
    ui->DatabaseStatus->setPixmap(the_pixmap);
 
    return(DatabaseOpen);
}

References LOG_DEBUG, LOG_WARNING, LogAdd(), MODE_DATABASE, and ui.

Referenced by Open(), and RemoveDatabase().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadDatabaseDrivers()

void DatabaseManager::LoadDatabaseDrivers ( QComboBox * DriverList )

private

Load the know Database Drivers.

Parameters

Database

Driver List

Definition at line 45 of file databasemanager.cpp.

{
    // Obtain the List of Available Drivers
    QStringList driver_list = QSqlDatabase::drivers();
    DatabaseDriver->addItems(driver_list);
 
    LogAdd(LOG_DEBUG, MODE_DATABASE, QString("%1 Database Drivers identified.").arg(QString::number(driver_list.count())));
}

References LOG_DEBUG, LogAdd(), and MODE_DATABASE.

Referenced by DatabaseManager().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadDefaultDBParameters

void DatabaseManager::LoadDefaultDBParameters ( void )

slot

Load the default Database Paranmeters.

Definition at line 54 of file databasemanager.cpp.

{
    // Set the Default Database Type
    QString database_driver_type = "QMARIADB";
 
    // Load Log Setup Parameters
    QSettings settings;
    ui->DatabaseName->setText(settings.value( "Database/DatabaseName", "opensim").toString());
    ui->DatabaseHost->setText(settings.value( "Database/DatabaseHost", "localhost").toString());
    ui->DatabaseUsername->setText(settings.value( "Database/DatabaseUser", "mark" ).toString());
    ui->DatabasePassword->setText(settings.value( "Database/DatabasePassword", "xg27QHUx%" ).toString());
    ui->DatabaseDriver->setCurrentText(settings.value( "Database/DatabaseDriver", database_driver_type ).toString());
 
 
 
    QString fake_password_string = "";
    if (ui->DatabasePassword->text().length() != 0) fake_password_string = "*******";
    LogAdd(LOG_DEBUG, MODE_DATABASE, QString("Default Database parameters loaded:- Database: %1,  Host: %2,  Driver: %3,  User: %4, Password: %5")
                                       .arg(ui->DatabaseName->text(), ui->DatabaseHost->text(), ui->DatabaseDriver->currentText(), ui->DatabaseUsername->text(), fake_password_string) );
}

References LOG_DEBUG, LogAdd(), MODE_DATABASE, and ui.

Referenced by DatabaseManager().

Here is the call graph for this function:

Here is the caller graph for this function:

LogAdd()

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

private

Send Message to the Log.

Parameters

Severity	Severity of the Log Message
Mode	Which part of the program does the message relate to
Message	Text message to be added to the Log

Definition at line 137 of file databasemanager.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 CheckIfOpen(), LoadDatabaseDrivers(), LoadDefaultDBParameters(), and RemoveDatabase().

Here is the call graph for this function:

Here is the caller graph for this function:

Open()

bool DatabaseManager::Open ( void )

private

Open the Database witht selected parameters.

Definition at line 94 of file databasemanager.cpp.

{
    QSqlDatabase db = QSqlDatabase::addDatabase(ui->DatabaseDriver->currentText()); is_database = true;
 
    // Pass the Parameters to the Database
    db.setHostName(ui->DatabaseHost->text());
    db.setDatabaseName(ui->DatabaseName->text());
    db.setUserName(ui->DatabaseUsername->text());
    db.setPassword(ui->DatabasePassword->text());
 
    // Attempt to Open the Database
    is_open = CheckIfOpen(db.open());
    return(is_open);
}

References CheckIfOpen(), is_database, is_open, and ui.

Referenced by ReconnectDatabase().

Here is the call graph for this function:

Here is the caller graph for this function:

ReconnectDatabase

void DatabaseManager::ReconnectDatabase ( void )

slot

Reconnect to the databse using the current parameters.

Definition at line 109 of file databasemanager.cpp.

{
    // Remove an existing Database & Attempt to Open a New One
    RemoveDatabase();
    Open();
}

References Open(), and RemoveDatabase().

Referenced by DatabaseManager().

Here is the call graph for this function:

Here is the caller graph for this function:

RemoveDatabase()

void DatabaseManager::RemoveDatabase ( void )

private

Remove the current active database.

Definition at line 75 of file databasemanager.cpp.

{
    QSqlDatabase db = QSqlDatabase::database();
 
    if (is_open)
    {
        db.close();
        is_open = CheckIfOpen(false);
    }
 
    // Give Up if there was no Database Existing
    if (!is_database) return;
 
    // Get the Name of the Current Database
    QString database_connection = db.connectionName();
    QSqlDatabase::removeDatabase(database_connection);
 
    LogAdd(LOG_INFO, MODE_DATABASE, "Database has been removed.");
}

References CheckIfOpen(), is_database, is_open, LOG_INFO, LogAdd(), and MODE_DATABASE.

Referenced by ReconnectDatabase(), and ~DatabaseManager().

Here is the call graph for this function:

Here is the caller graph for this function:

SendLogEntry

void DatabaseManager::SendLogEntry ( REMOTE_LOG_ENTRY LogEntry )

signal

Send Log Entry via the Signal-Slot Method.

Parameters

LogEntry

Structure holding the Log Entry parameters

Referenced by LogAdd().

Here is the caller graph for this function:

Field Documentation

is_database

bool DatabaseManager::is_database

private

Flag to indicate if there is a database.

Definition at line 84 of file databasemanager.h.

Referenced by DatabaseManager(), Open(), and RemoveDatabase().

is_open

bool DatabaseManager::is_open

private

Flag to indicate if database is open.

Definition at line 90 of file databasemanager.h.

Referenced by DatabaseManager(), Open(), and RemoveDatabase().

ui

Ui::MainWindow* DatabaseManager::ui

private

Pointer to the Main Window.

Definition at line 79 of file databasemanager.h.

Referenced by CheckIfOpen(), DatabaseManager(), LoadDefaultDBParameters(), Open(), and ~DatabaseManager().

---

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

• databasemanager.h
• databasemanager.cpp