LicenceManager Class Reference

Class to Manager the Project Licences. More...

#include <licencemanager.h>

Inheritance diagram for LicenceManager:

Collaboration diagram for LicenceManager:

Public Slots
void	SaveQtLicence (void)
	Save the Default Qt Licence to settings.
void	ReadPrimaryTool (int ToolIndex)
	read Primary Tool & Apply any licence Restrictions
void	ReadLicenceState (LICENCE_STATE LicenceState)
	process the Licence state including any restrictions
void	TriggerSendLicence (void)
	Trigger to send out the Licence states.
void	DoClear (void)
	Resest the Licences fro the Database.

Signals
void	SendLogEntry (REMOTE_LOG_ENTRY LogEntry)
	Send Log Entry to the Log \LogEntry Structure holding Log information.
void	SendLicenceState (LICENCE_STATE LicenceState)
	Send the State of the Licences.
void	UpdateSoftwareLicence (QString LicenceName)
	Emits the Text Name of the Software Lidence.
void	UpdateHardwareLicence (QString LicenceName)
	Emits the Text Name of the Hardware Lidence.
void	UpdateDocumentationLicence (QString LicenceName)
	Emits the Text Name of the Documentation Lidence.

Public Member Functions
	LicenceManager (Ui::MainWindow *UI_Window)
	LicenceManager Construction routine.
void	LoadLicences (void)
	Load the Licence Data from the Database.
void	WriteLicenceState (void)
	Read the Current Lilcence Stae on Display & Send out.

Private Slots
void	SetSoftwareLicence (int LicenceIndex)
	Set the Software Licence.
void	SetHardwareLicence (int LicenceIndex)
	Set the Hardware Licence.
void	SetDocumentationLicence (int LicenceIndex)
	Set the Documentation Licence.

Private Member Functions
void	LogAdd (LOGGING_SEVERITY Severity, LOGGING_MODE Mode, const QString Message)
	Add a Log Entry.
void	SendStatusMessage (QString Type, int Counter)
	Send the Type of Licence and the number licences loaded.
void	LoadQtLicence (void)
	Load the Qt Licence from settings.
void	ProcessSoftwareRestriction (int DocumentationRestriction)
	Use the Soft Restrictions to limit the possible licence selections.
void	ProcessDocumentationRestriction (int DocumentationRestriction)
	Use the Documenrtation Restrictions to limit the possible licence selections.
void	ProcessHardwareRestriction (int HardwareRestriction)
	Use the Hardware Restrictions to limit the possible licence selections.
uint	GetLicenceIndex (QString LicenceText)
	Find the Licence Index from the Licence text.

Private Attributes
Ui::MainWindow *	ui
	Pointer to the Main Window.
int	primary_tool_index
	Index of the Primary Tool.
int	qt_licence_index
	Index of the Qt Licence.

Detailed Description

Class to Manager the Project Licences.

Definition at line 17 of file licencemanager.h.

Constructor & Destructor Documentation

LicenceManager()

LicenceManager::LicenceManager ( Ui::MainWindow * UI_Window )

explicit

LicenceManager Construction routine.

Parameters

UI_Window

POinter to the main window

Member Function Documentation

DoClear

void LicenceManager::DoClear ( void )

slot

Resest the Licences fro the Database.

Definition at line 281 of file licencemanager.cpp.

{
    LoadLicences();
}

References LoadLicences().

Here is the call graph for this function:

GetLicenceIndex()

uint LicenceManager::GetLicenceIndex ( QString LicenceText )

private

Find the Licence Index from the Licence text.

Parameters

Licence

Short Name Licence Text

Returns

Index of the Licence Entry

Return the Licence Index, or 0 if there is no match

Definition at line 264 of file licencemanager.cpp.

{
    uint licence_index = 0;
    QSqlQuery licence_index_query( QString("select licence_index from licence where short_name = '%1'").arg(LicenceText));
    while ( licence_index_query.next() )
    {
        licence_index = licence_index_query.value(0).toInt();
    }
    return(licence_index);
}

Referenced by WriteLicenceState().

Here is the caller graph for this function:

LoadLicences()

void LicenceManager::LoadLicences

(

void

)

Load the Licence Data from the Database.

Definition at line 17 of file licencemanager.cpp.

{
    QSqlDatabase db = QSqlDatabase::database();
 
    // Clear the Licence List
    ui->SoftwareLicenceList->clear();
 
    // Get a List of the Development Families from Database
    QSqlQuery soft_licence_query( "select licence_index, short_name from licence where licence_type = 1 or licence_type = 3 order by short_name" );
 
    // Step through the Results
    int row_index = 0;
    while ( soft_licence_query.next() )
    {
        int licence_index = soft_licence_query.value(0).toInt();
        QString software_entry = soft_licence_query.value(1).toString();
        ui->SoftwareLicenceList->addItem( software_entry, licence_index );
        row_index++;
    }
    SendStatusMessage("Software Licence", row_index);
 
    // Clear the Licence List
    ui->DocumentationLicenceList->clear();
 
    // Get a List of the Development Families from Database
    QSqlQuery doc_licence_query( "select licence_index, short_name from licence where licence_type = 1 or licence_type = 2 order by short_name" );
 
    // Step through the Results
    row_index = 0;
    while ( doc_licence_query.next() )
    {
        int licence_index = doc_licence_query.value(0).toInt();
        QString doc_licence_entry = doc_licence_query.value(1).toString();
        ui->DocumentationLicenceList->addItem( doc_licence_entry, licence_index );
        row_index++;
    }
    SendStatusMessage("Documentation Licence", row_index);
 
    // Clear the Licence List
    ui->HardwareLicenceList->clear();
 
    // Get a List of the Development Families from Database
    QSqlQuery hardware_licence_query( "select licence_index, short_name from licence where licence_type = 1 or licence_type = 4 order by short_name" );
 
    // Step through the Results
    row_index = 0;
    while ( hardware_licence_query.next() )
    {
        int licence_index = hardware_licence_query.value(0).toInt();
        QString hardware_entry = hardware_licence_query.value(1).toString();
        ui->HardwareLicenceList->addItem( hardware_entry, licence_index );
        row_index++;
    }
    SendStatusMessage("Hardware Licence", row_index);
 
    // Initialise the Qt Licence List
    ui->QtLicenceList->clear();
    ui->QtLicenceList->addItems({QString("Community"), QString("Professional"), QString("Enterprise")});
    SendStatusMessage("Qt Licence List", 3);
 
    LoadQtLicence();
}

References LoadQtLicence(), SendStatusMessage(), and ui.

Referenced by DoClear().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadQtLicence()

void LicenceManager::LoadQtLicence ( void )

private

Load the Qt Licence from settings.

Definition at line 92 of file licencemanager.cpp.

{
    // Open the Settings Data
    QSettings settings( "brigadoon/netprojectmanager" );
    ui->QtLicenceList->setCurrentText(settings.value( "Qt/Licence", "Community").toString());
    LogAdd(LOG_DEBUG, MODE_CONFIG, QString("Qt Licence for Site loaded as %1.").arg(ui->QtLicenceList->currentText()));
}

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

Referenced by LoadLicences().

Here is the call graph for this function:

Here is the caller graph for this function:

LogAdd()

void LicenceManager::LogAdd ( LOGGING_SEVERITY Severity, LOGGING_MODE Mode, const 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 108 of file licencemanager.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 LoadQtLicence(), SaveQtLicence(), SendStatusMessage(), and TriggerSendLicence().

Here is the call graph for this function:

Here is the caller graph for this function:

ProcessDocumentationRestriction()

void LicenceManager::ProcessDocumentationRestriction ( int DocumenationRestriction )

private

Use the Documenrtation Restrictions to limit the possible licence selections.

Parameters

DocumentationRestriction

Posible restriction to Software Licences

Definition at line 198 of file licencemanager.cpp.

{
    bool licence_enabled = true;
 
    // Check if there is No Documentation ERestriction
    if (DocumentationRestriction != 0)
    {
        QString licence_name;
        QSqlDatabase db = QSqlDatabase::database();
        int row_index = 0;
        QSqlQuery licence_restriction_query(QString("select short_name from licence where licence_index = %1").arg(QString::number(DocumentationRestriction)));
        while ( licence_restriction_query.next() )
        {
            licence_name = licence_restriction_query.value(0).toString();
            row_index++;
        }
 
        if (row_index != 0)
        {
            ui->DocumentationLicenceList->setCurrentText(licence_name);
        }
    }
    ui->DocumentationLicenceList->setEnabled(licence_enabled);
}

References ui.

Referenced by ReadLicenceState(), and ReadPrimaryTool().

Here is the caller graph for this function:

ProcessHardwareRestriction()

void LicenceManager::ProcessHardwareRestriction ( int HardwareRestriction )

private

Use the Hardware Restrictions to limit the possible licence selections.

Parameters

HardwareRestriction

Posible restrictions to Hardware Licences

Definition at line 223 of file licencemanager.cpp.

{
        bool licence_enabled = true;
 
    // Check if there is No Documentation Restriction
    if (HardwareRestriction != 0)
    {
        QString licence_name;
        QSqlDatabase db = QSqlDatabase::database();
        int row_index = 0;
        QSqlQuery licence_restriction_query(QString("select short_name from licence where licence_index = %1").arg(QString::number(HardwareRestriction)));
        while ( licence_restriction_query.next() )
        {
            licence_name = licence_restriction_query.value(0).toString();
            row_index++;
        }
 
        if (row_index != 0)
        {
            ui->HardwareLicenceList->setCurrentText(licence_name);
        }
    }
    ui->HardwareLicenceList->setEnabled(licence_enabled);
}

References ui.

Referenced by ReadLicenceState(), and ReadPrimaryTool().

Here is the caller graph for this function:

ProcessSoftwareRestriction()

void LicenceManager::ProcessSoftwareRestriction ( int SoftwareRestriction )

private

Use the Soft Restrictions to limit the possible licence selections.

Parameters

SoftwareRestriction

Posible restriction to Software Licences

Definition at line 172 of file licencemanager.cpp.

{
    QString licence_name;
    bool licence_enabled = true;
 
    // Check if there is No Software ERestriction
    if (SoftwareRestriction != 0)
    {
        QSqlDatabase db = QSqlDatabase::database();
        int row_index = 0;
        QSqlQuery licence_restriction_query(QString("select short_name from licence where licence_index = %1").arg(QString::number(SoftwareRestriction)));
        while ( licence_restriction_query.next() )
        {
            licence_name = licence_restriction_query.value(0).toString();
            row_index++;
        }
 
        if (row_index != 0)
        {
            ui->SoftwareLicenceList->setCurrentText(licence_name);
            licence_enabled = false;
        }
    }
    ui->SoftwareLicenceList->setEnabled(licence_enabled);
}

References ui.

Referenced by ReadLicenceState(), and ReadPrimaryTool().

Here is the caller graph for this function:

ReadLicenceState

void LicenceManager::ReadLicenceState ( LICENCE_STATE LicenceState )

slot

process the Licence state including any restrictions

Parameters

LicenceState

Structure holding the state of the licences

Definition at line 248 of file licencemanager.cpp.

{
    ProcessSoftwareRestriction(LicenceState.SoftwareLicence);
    ProcessDocumentationRestriction(LicenceState.DocumentationLicence);
    ProcessHardwareRestriction(LicenceState.HardwareLicence);
}

References LICENCE_STATE::DocumentationLicence, LICENCE_STATE::HardwareLicence, ProcessDocumentationRestriction(), ProcessHardwareRestriction(), ProcessSoftwareRestriction(), and LICENCE_STATE::SoftwareLicence.

Here is the call graph for this function:

ReadPrimaryTool

void LicenceManager::ReadPrimaryTool ( int ToolIndex )

slot

read Primary Tool & Apply any licence Restrictions

Definition at line 117 of file licencemanager.cpp.

{
    // Assume No Restrictions will be found
    ui->SoftwareLicenceList->setEnabled(true);
    ui->DocumentationLicenceList->setEnabled(true);
    ui->HardwareLicenceList->setEnabled(true);
 
    QSqlDatabase db = QSqlDatabase::database();
 
    // See if there is a Licence Restriction for this Tool from Database
    QSqlQuery tool_restriction_query( QString("select software_licence_restriction, documentation_licence_restriction, hardware_licence_restriction from compiler_instance where compiler_instance_index = %1").arg(QString::number(ToolIndex+1)));
 
    // Find Any Licence Restrictions for the Primary Tool
    int row_index = 0;
    int software_restriction; int documentation_restriction; int hardware_restriction;
    while ( tool_restriction_query.next() )
    {
        software_restriction = tool_restriction_query.value(0).toInt();
        documentation_restriction = tool_restriction_query.value(1).toInt();
        hardware_restriction = tool_restriction_query.value(2).toInt();
        row_index++;
    }
 
    // If Entries were found for the Primary Tool, Process Them
    if (row_index != 0)
    {
        // Process Software Licemce Exceptions (if any)
        bool do_software_restriction = true;
 
        // Apply Special Exceptions (if any)
        if ((ToolIndex == 2) &&(ui->QtLicenceList->currentIndex() != 0)) do_software_restriction = false;
 
        // Process the Software Restrictions
        if (do_software_restriction) ProcessSoftwareRestriction(software_restriction);
 
        // Process Software Licemce Exceptions (if any)
        bool do_documentation_restriction = false;
 
        // Apply Special Exceptions (if any)
 
 
        // Process the Documenttaion Restrictions
        if (do_documentation_restriction) ProcessDocumentationRestriction(documentation_restriction);
 
        // Process Software Licemce Exceptions (if any)
        bool do_hardware_restriction = false;
 
        // Apply Special Exceptions (if any)
 
 
        // Process the Software Restrictions
        if (do_hardware_restriction) ProcessHardwareRestriction(hardware_restriction);
    }
}

References ProcessDocumentationRestriction(), ProcessHardwareRestriction(), ProcessSoftwareRestriction(), and ui.

Here is the call graph for this function:

SaveQtLicence

void LicenceManager::SaveQtLicence ( void )

slot

Save the Default Qt Licence to settings.

Definition at line 100 of file licencemanager.cpp.

{
    // Open the Settings Data
    QSettings settings( "brigadoon/netprojectmanager" );
    settings.setValue( "Qt/Licence", ui->QtLicenceList->currentText());
    LogAdd(LOG_INFO, MODE_CONFIG, QString("Qt Licence for Site saved as %1.").arg(ui->QtLicenceList->currentText()));
}

References LOG_INFO, LogAdd(), MODE_CONFIG, and ui.

Here is the call graph for this function:

SendLicenceState

void LicenceManager::SendLicenceState ( LICENCE_STATE LicenceState )

signal

Send the State of the Licences.

Parameters

Structure

holding Licence Information

Referenced by WriteLicenceState().

Here is the caller graph for this function:

SendLogEntry

void LicenceManager::SendLogEntry ( REMOTE_LOG_ENTRY LogEntry )

signal

Send Log Entry to the Log \LogEntry Structure holding Log information.

Referenced by LogAdd().

Here is the caller graph for this function:

SendStatusMessage()

void LicenceManager::SendStatusMessage ( QString Type, int Counter )

private

Send the Type of Licence and the number licences loaded.

Parameters

Type	The Type of Licence in text
Counter	The number Licences of that Type loaded

Definition at line 80 of file licencemanager.cpp.

{
    if (Counter > 0)
    {
        LogAdd(LOG_DEBUG, MODE_DATABASE, QString("%1 Loaded with %2 entries.").arg(Type, QString::number(Counter)));
    }
    else
    {
        LogAdd(LOG_ERROR, MODE_DATABASE, QString("%1 FAILED to load any entries.").arg(Type, Counter));
    }
}

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

Referenced by LoadLicences().

Here is the call graph for this function:

Here is the caller graph for this function:

SetDocumentationLicence

void LicenceManager::SetDocumentationLicence ( int LicenceIndex )

privateslot

Set the Documentation Licence.

Parameters

LicenceIndex

Definition at line 298 of file licencemanager.cpp.

{
    QString LicenceName = ui->DocumentationLicenceList->itemText(LicenceIndex);
    emit UpdateDocumentationLicence(LicenceName);
}

References ui, and UpdateDocumentationLicence().

Here is the call graph for this function:

SetHardwareLicence

void LicenceManager::SetHardwareLicence ( int LicenceIndex )

privateslot

Set the Hardware Licence.

Parameters

LicenceIndex

Definition at line 292 of file licencemanager.cpp.

{
    QString LicenceName = ui->HardwareLicenceList->itemText(LicenceIndex);
    emit UpdateHardwareLicence(LicenceName);
}

References ui, and UpdateHardwareLicence().

Here is the call graph for this function:

SetSoftwareLicence

void LicenceManager::SetSoftwareLicence ( int LicenceIndex )

privateslot

Set the Software Licence.

Parameters

LicenceIndex

Definition at line 286 of file licencemanager.cpp.

{
    QString LicenceName = ui->SoftwareLicenceList->itemText(LicenceIndex);
    emit UpdateSoftwareLicence(LicenceName);
}

References ui, and UpdateSoftwareLicence().

Here is the call graph for this function:

TriggerSendLicence

void LicenceManager::TriggerSendLicence ( void )

slot

Trigger to send out the Licence states.

Definition at line 275 of file licencemanager.cpp.

{
    LogAdd(LOG_DEBUG, MODE_QT, "Request to Send Licences Received.");
    WriteLicenceState();
}

References LOG_DEBUG, LogAdd(), MODE_QT, and WriteLicenceState().

Here is the call graph for this function:

UpdateDocumentationLicence

void LicenceManager::UpdateDocumentationLicence ( QString LicenceName )

signal

Emits the Text Name of the Documentation Lidence.

Referenced by SetDocumentationLicence().

Here is the caller graph for this function:

UpdateHardwareLicence

void LicenceManager::UpdateHardwareLicence ( QString LicenceName )

signal

Emits the Text Name of the Hardware Lidence.

Referenced by SetHardwareLicence().

Here is the caller graph for this function:

UpdateSoftwareLicence

void LicenceManager::UpdateSoftwareLicence ( QString LicenceName )

signal

Emits the Text Name of the Software Lidence.

Referenced by SetSoftwareLicence().

Here is the caller graph for this function:

WriteLicenceState()

void LicenceManager::WriteLicenceState

(

void

)

Read the Current Lilcence Stae on Display & Send out.

Definition at line 255 of file licencemanager.cpp.

{
    LICENCE_STATE project_licences;
    project_licences.SoftwareLicence = GetLicenceIndex(ui->SoftwareLicence->text());
    project_licences.DocumentationLicence = GetLicenceIndex(ui->SoftwareLicence->text());
    project_licences.HardwareLicence = GetLicenceIndex(ui->HardwareLicence->text());
    emit SendLicenceState(project_licences);
}

References LICENCE_STATE::DocumentationLicence, GetLicenceIndex(), LICENCE_STATE::HardwareLicence, SendLicenceState(), LICENCE_STATE::SoftwareLicence, and ui.

Referenced by TriggerSendLicence().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

primary_tool_index

int LicenceManager::primary_tool_index

private

Index of the Primary Tool.

Definition at line 86 of file licencemanager.h.

qt_licence_index

int LicenceManager::qt_licence_index

private

Index of the Qt Licence.

Definition at line 92 of file licencemanager.h.

ui

Ui::MainWindow* LicenceManager::ui

private

Pointer to the Main Window.

Definition at line 80 of file licencemanager.h.

Referenced by LoadLicences(), LoadQtLicence(), ProcessDocumentationRestriction(), ProcessHardwareRestriction(), ProcessSoftwareRestriction(), ReadPrimaryTool(), SaveQtLicence(), SetDocumentationLicence(), SetHardwareLicence(), SetSoftwareLicence(), and WriteLicenceState().

---

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

• licencemanager.h
• licencemanager.cpp