|
Project Documentation Manager BRIGADOON-0002
Project Documentation Manager
|
Class for Program Vesrion. More...
#include <programversion.h>
Public Slots | |
| void | DoClear (void) |
| Reset the Version Information. | |
| void | ReadProjectInfo (PROJECT_INFORMATION *ProjectId) |
| Read The Project Information. | |
| void | ReadProjectDateTime (QDateTime ProjectDateTime) |
| Read the Project DateTime. | |
Signals | |
| void | SendVersionInfo (REMOTE_VERSION_ENTRY VersionEntry) |
| Send the Version information by the Signal-Slot Method. | |
| void | SendLogEntry (REMOTE_LOG_ENTRY LogEntry) |
| Send Log Entry to the Log \LogEntry Structure holding Log information. | |
| void | SendMajorVersion (int MajorVersion) |
| Send the Major Version. | |
| void | SendMinorVersion (int MinorVersion) |
| Send the Minor Version. | |
| void | SendRevision (int Revision) |
| Send the Revision. | |
| void | SendProjectDateTime (QString ProjectDateTime) |
| Send the Current DateTime as the Version DateTime. | |
Public Member Functions | |
| ProgramVersion (Ui::MainWindow *UI_Window) | |
| Program Version Class Constructor. | |
Private Slots | |
| void | SetMajorVersion (quint16 Value) |
| Sets the Project's Major Version to Value. | |
| void | SetMinorVersion (quint16 Value) |
| Sets the Project's Minor Version to Value. | |
| void | SetRevision (quint16 Value) |
| Sets the Project's Revision to Value. | |
| void | SetStepOverride (int State) |
| Set the Status of Version Step Override. | |
| void | UpdateMajorVersion (int MajorVersion) |
| Set the Major Version to the Value Supplied. | |
| void | UpdateMinorVersion (int MinorVersion) |
| Set the Minor Version to the Value Supplied. | |
| void | UpdateRevision (int Revision) |
| Set the Revision to the Value Supplied. | |
| void | SetVersionDate (void) |
| Set the Version Date. | |
| void | ReadVersionText (uint ProjectIndex, VERSION_INFO Version) |
| Read the Version Text for the Project's Version. | |
| void | SaveVersion (void) |
| Save the Project's Version. | |
| void | SetOverrideEnable (bool Enable) |
| Enable/Disable the Override. | |
| REMOTE_VERSION_ENTRY | WriteVersion (uint ProjectId) |
| Read the Version Information into Structure. | |
| void | LogProgramVersion (REMOTE_VERSION_ENTRY VersionInstance) |
| Convert the Program Version to Log Message and Send It. | |
Private Member Functions | |
| void | PresetMajorVersion (quint16 Value) |
| Preset the Major Version to a Value. | |
| void | LogAdd (LOGGING_SEVERITY Severity, LOGGING_MODE Mode, QString Message) |
| void | PresetMinorVersion (quint16 Value) |
| Preset the Minor Version to a Value. | |
| void | PresetRevision (quint16 Value) |
| Preset the Revision to a Value. | |
| QString | ReadFullHistory (int ProjectIndex) |
| Read the entire history of the Project as a string. | |
| QString | FormatVersion (int MajorVersion, int MinorVersion, int Revision) |
| Format the numeric version (major, minor, revision) as text. | |
Private Attributes | |
| Ui::MainWindow * | ui |
| uint | project_index = 0 |
| Project Index Number. | |
| VERSION_INFO | version_info |
| Structure holding Version Information. | |
| QString | timestamp_format_string |
| DateTime Format String. | |
Class for Program Vesrion.
Definition at line 22 of file programversion.h.
|
explicit |
Program Version Class Constructor.
| UI_Window | Main Program Window |
Definition at line 9 of file programversion.cpp.
References DATETIME_DISPLAY_FORMAT, ReadProjectDateTime(), SaveVersion(), SetStepOverride(), timestamp_format_string, ui, UpdateMajorVersion(), UpdateMinorVersion(), and UpdateRevision().
|
slot |
Reset the Version Information.
Definition at line 187 of file programversion.cpp.
References SetMajorVersion(), SetMinorVersion(), SetOverrideEnable(), SetRevision(), SetVersionDate(), and ui.
|
private |
Format the numeric version (major, minor, revision) as text.
| MajorVersion | Major Project Version |
| MinorVersion | Minor Project Version |
| Revision | Revision of Major:Minor version |
Definition at line 302 of file programversion.cpp.
Referenced by ReadFullHistory(), and WriteVersion().
|
private |
Definition at line 170 of file programversion.cpp.
References REMOTE_LOG_ENTRY::Message, REMOTE_LOG_ENTRY::Mode, SendLogEntry(), and REMOTE_LOG_ENTRY::Severity.
Referenced by LogProgramVersion(), SaveVersion(), and SetStepOverride().
|
privateslot |
Convert the Program Version to Log Message and Send It.
Definition at line 179 of file programversion.cpp.
References VERSION_INFO::FullVersionString, LOG_DEBUG, LogAdd(), MODE_OPERATOR, timestamp_format_string, VERSION_INFO::VersionDate, and REMOTE_VERSION_ENTRY::VersionInfo.
Referenced by SetVersionDate().
|
private |
Preset the Major Version to a Value.
| Value | The Valule of the Major Version |
This function is used to preset the Major Value with out affecting the Minor or Revision Values.
Definition at line 76 of file programversion.cpp.
References SetMajorVersion(), and ui.
Referenced by ReadProjectInfo().
|
private |
Preset the Minor Version to a Value.
| Value | The Valule of the Minor Version |
This function is used to preset the Minor Value with out affecting the Major or Revision Values.
Definition at line 84 of file programversion.cpp.
References SetMinorVersion(), and ui.
Referenced by ReadProjectInfo(), and SetMajorVersion().
|
private |
Preset the Revision to a Value.
| Value | The Valule of the Revision |
This function is used to preset the Revision Value with out affecting the Major or Minor Values.
Definition at line 92 of file programversion.cpp.
References SetRevision(), and ui.
Referenced by ReadProjectInfo(), and SetMinorVersion().
|
private |
Read the entire history of the Project as a string.
| ProjectIndex | Project's database index |
Definition at line 310 of file programversion.cpp.
References FormatVersion(), and ui.
Referenced by ReadVersionText(), and SaveVersion().
|
slot |
Read the Project DateTime.
Definition at line 297 of file programversion.cpp.
References SendProjectDateTime(), and timestamp_format_string.
Referenced by ProgramVersion().
|
slot |
Read The Project Information.
Definition at line 137 of file programversion.cpp.
References VERSION_INFO::MajorVersion, VERSION_INFO::MinorVersion, PresetMajorVersion(), PresetMinorVersion(), PresetRevision(), project_index, PROJECT_INFORMATION::ProjectDesc, PROJECT_DESCRIPTION::ProjectIndex, ReadVersionText(), VERSION_INFO::Revision, timestamp_format_string, ui, version_info, VERSION_INFO::VersionDate, and PROJECT_INFORMATION::VersionInfo.
|
privateslot |
Read the Version Text for the Project's Version.
Definition at line 200 of file programversion.cpp.
References VERSION_INFO::MajorVersion, VERSION_INFO::MinorVersion, ReadFullHistory(), VERSION_INFO::Revision, and ui.
Referenced by ReadProjectInfo(), SetMajorVersion(), SetMinorVersion(), and SetRevision().
|
privateslot |
Save the Project's Version.
Definition at line 221 of file programversion.cpp.
References DATETIME_DATABASE_FORMAT, VERSION_INFO::FullVersionString, LOG_DEBUG, LOG_ERROR, LogAdd(), MODE_DATABASE, project_index, ReadFullHistory(), SendVersionInfo(), ui, REMOTE_VERSION_ENTRY::VersionInfo, and WriteVersion().
Referenced by ProgramVersion().
|
signal |
Send Log Entry to the Log \LogEntry Structure holding Log information.
Referenced by LogAdd().
|
signal |
Send the Major Version.
| MajorVersion | The value of the Major Version |
Referenced by UpdateMajorVersion().
|
signal |
Send the Minor Version.
| MinorVersion | The value of the Minor Version |
Referenced by UpdateMinorVersion().
|
signal |
Send the Current DateTime as the Version DateTime.
| ProjectDateTime | The Project's DateTime for this Version |
Referenced by ReadProjectDateTime().
|
signal |
Send the Revision.
| Revision | The value of the Revision |
Referenced by UpdateRevision().
|
signal |
Send the Version information by the Signal-Slot Method.
| VersionEntry | Structure containing the Project's Version Information |
Referenced by SaveVersion().
|
privateslot |
Sets the Project's Major Version to Value.
| Value | Number to which Major Version will be set |
The function will set the Project's major version to the passed value.
If the OverrideStepControl is set, the value (between 0 and 999) will not affect the Minor and Revision values. If the override is not set,the Minor Version and ultimately the Revision will be set to zero. Additionally, the limits will be set so that the Major Version can only be increased by 1.
Definition at line 26 of file programversion.cpp.
References PresetMinorVersion(), project_index, ReadVersionText(), ui, and version_info.
Referenced by DoClear(), and PresetMajorVersion().
|
privateslot |
Sets the Project's Minor Version to Value.
| Value | Number to which Minor Version will be set |
The function will set the Project's minor version to the passed value.
If the OverrideStepControl is set, the value (between 0 and 999) will not affect the Revision values. If the override is not set,the Revision will be set to zero. Additionally, the limits will be set so that the Minor Version can only be increased by 1.
Definition at line 43 of file programversion.cpp.
References PresetRevision(), project_index, ReadVersionText(), ui, and version_info.
Referenced by DoClear(), and PresetMinorVersion().
|
privateslot |
Enable/Disable the Override.
Definition at line 132 of file programversion.cpp.
References ui.
Referenced by DoClear().
|
privateslot |
Sets the Project's Revision to Value.
| Value | Number to which Revision will be set |
The function will set the Project's revision to the passed value.
If the OverrideStepControl is set, the value can be set to 0 and 999 inclusive. If the override is not set, the limits will be set so that the Revision can only be increased by 1.
Definition at line 60 of file programversion.cpp.
References project_index, ReadVersionText(), ui, and version_info.
Referenced by DoClear(), and PresetRevision().
|
privateslot |
Set the Status of Version Step Override.
Definition at line 100 of file programversion.cpp.
References LOG_DEBUG, LogAdd(), MODE_OPERATOR, SetVersionDate(), and ui.
Referenced by ProgramVersion().
|
privateslot |
Set the Version Date.
Definition at line 162 of file programversion.cpp.
References LogProgramVersion(), project_index, timestamp_format_string, ui, and WriteVersion().
Referenced by DoClear(), SetStepOverride(), UpdateMajorVersion(), UpdateMinorVersion(), and UpdateRevision().
|
privateslot |
Set the Major Version to the Value Supplied.
| MajorVersion | Major Project Version to Use |
Definition at line 279 of file programversion.cpp.
References SendMajorVersion(), and SetVersionDate().
Referenced by ProgramVersion().
|
privateslot |
Set the Minor Version to the Value Supplied.
| MinorVersion | Minor Project Version to Use |
Definition at line 285 of file programversion.cpp.
References SendMinorVersion(), and SetVersionDate().
Referenced by ProgramVersion().
|
privateslot |
Set the Revision to the Value Supplied.
| Revision | Revision to Use |
Definition at line 291 of file programversion.cpp.
References SendRevision(), and SetVersionDate().
Referenced by ProgramVersion().
|
privateslot |
Read the Version Information into Structure.
| ProjectId | Project Database Index |
Definition at line 149 of file programversion.cpp.
References FormatVersion(), VERSION_INFO::FullVersionString, VERSION_INFO::MajorVersion, VERSION_INFO::MinorVersion, REMOTE_VERSION_ENTRY::ProjectNumber, VERSION_INFO::Revision, timestamp_format_string, ui, VERSION_INFO::VersionDate, REMOTE_VERSION_ENTRY::VersionInfo, and VERSION_INFO::VersionString.
Referenced by SaveVersion(), and SetVersionDate().
|
private |
Project Index Number.
Definition at line 65 of file programversion.h.
Referenced by ReadProjectInfo(), SaveVersion(), SetMajorVersion(), SetMinorVersion(), SetRevision(), and SetVersionDate().
|
private |
DateTime Format String.
Definition at line 77 of file programversion.h.
Referenced by LogProgramVersion(), ProgramVersion(), ReadProjectDateTime(), ReadProjectInfo(), SetVersionDate(), and WriteVersion().
|
private |
brief Pointer to the main window
Definition at line 59 of file programversion.h.
Referenced by DoClear(), PresetMajorVersion(), PresetMinorVersion(), PresetRevision(), ProgramVersion(), ReadFullHistory(), ReadProjectInfo(), ReadVersionText(), SaveVersion(), SetMajorVersion(), SetMinorVersion(), SetOverrideEnable(), SetRevision(), SetStepOverride(), SetVersionDate(), and WriteVersion().
|
private |
Structure holding Version Information.
Definition at line 71 of file programversion.h.
Referenced by ReadProjectInfo(), SetMajorVersion(), SetMinorVersion(), and SetRevision().