Isis 3.0 Object Programmers' Reference |
Home |
#include <Application.h>
Public Member Functions | |
Application (int &argc, char *argv[]) | |
Constuctor for the Application object. | |
~Application () | |
Destroys the Application object. | |
int | Run (void(*funct)()) |
Runs the program defined in the function funct. | |
PvlGroup | Accounting () |
Creates accounting PvlGroup. | |
PvlObject | History () |
Creates an application history PvlObject. | |
void | RegisterGuiHelpers (std::map< QString, void * > helpers) |
void * | GetGuiHelper (QString helper) |
void | GuiReportError (IException &e) |
Loads the error message into the gui, but does not write it to the session log. | |
Static Public Member Functions | |
static UserInterface & | GetUserInterface () |
Returns the UserInterface object. | |
static void | Log (PvlGroup &results) |
Writes Pvl results to sessionlog and printfile. | |
static void | GuiLog (const Pvl &results) |
Writes the Pvl results to the sessionlog, but not to the printfile. | |
static void | GuiLog (const PvlGroup &results) |
Writes the PvlGroup results to the sessionlog, but not to the printfile. | |
static void | GuiLog (const QString &results) |
Writes the results to the sessionlog, but not to the printfile. | |
static QString | Name () |
Returns the name of the application. | |
static QString | UserName () |
Returns the user name. | |
static QString | HostName () |
Returns the host name. | |
static QString | DateTime (time_t *curtime=0) |
Returns the date and time as a QString. | |
static QString | Version () |
The Isis Version for this application. | |
static bool | HasParent () |
Returns whether the application has a parent or not. | |
static QString | userName () |
the user name. | |
static QString | hostName () |
static QString | isisVersion () |
Static Public Attributes | |
static bool | p_applicationForceGuiApp = false |
Private Member Functions | |
int | DirectIO () |
Returns the current number of I/O's. | |
int | PageFaults () |
Returns the current number of faults. | |
int | ProcessSwaps () |
Returns the current number of swaps. | |
void | SendParentData (QString, const QString &) |
void | SendParentErrors (PvlObject &errors) |
Sends errors to the parent. | |
void | FunctionCleanup () |
Cleans up after the function by writing the log, saving the history, and either sending the log to the parent if it has one, printing the log data to the terminal or showing the log in the gui. | |
int | FunctionError (IException &e) |
Adds the error to the session log, sends the error to the parent if it has one, loads the error message into the gui or prints it to the command line, gets the error type and returns it. | |
void | UpdateProgress (const QString &text, bool print) |
Updates the progress bar in the gui. | |
void | UpdateProgress (int percent, bool print) |
Updates the progress bar percent. | |
void | ProcessGuiEvents () |
Processes the gui events. | |
void | SetParentConnection (QLocalSocket *p_connection) |
void | EstablishConnections () |
void | WaitForCommand (int childSocket) |
Static Private Member Functions | |
static PvlGroup | GetUnameInfo () |
Runs various system specific uname commands and returns the results. | |
static PvlGroup | GetEnviromentInfo () |
Runs some printenv commands that return Isis related Enviroment Variables. | |
static QString | GetSystemDiskSpace () |
Runs df to see the disk space availability. | |
static QString | GetLibraryDependencies (QString file) |
Runs ldd on linux and sun and otool on macs to get information about the applicaiton run. | |
Private Attributes | |
int | p_BatchlistPass |
QLocalSocket * | p_connectionToParent |
time_t | p_startTime |
clock_t | p_startClock |
QString | p_datetime |
int | p_startDirectIO |
int | p_startPageFaults |
int | p_startProcessSwaps |
pid_t | p_childPid |
bool | p_childCaught |
UserInterface * | p_ui |
Pointer to a User Interface object. | |
pid_t | p_pid |
std::map< QString, void * > | p_guiHelpers |
Static Private Attributes | |
static QString | p_appName |
Friends | |
class | Gui |
class | Progress |
class | ProgramLauncher |
2005-12-16 Elizabeth Miller - Added documentation and -BATCHLIST capabilities
2006-02-13 Elizabeth Miller - Added GuiHelper Capabilities
2006-02-16 Jeff Anderson - Fixed race condition on sockets between communicating ISIS programs
2006-02-17 Fixed bug with application name being unknown if the user interface threw an error
2006-02-27 Elizabeth Miller - Added GuiLog and GuiReportError methods
2006-07-28 Jeff Anderson - Fixed another race condition with sockets between communicating ISIS programs. Also updated progress to output name of the program
2006-08-30 Jeff Anderson - Create a QCoreApplication if in command line mode.
2007-10-04 Steven Koechle - Added output capability for debugging log for -info flag
2008-01-04 Jeannie Walldren - Changed description of Log method
2008-01-09 Steven Lambright - Fixed Memory Leak
2008-04-16 Steven Lambright - Added parameter check that was removed from UserInterface
2008-06-18 Christopher Austin - Fixed documentation error
2008-06-19 Steven Lambright - Added CubeManager::CleanUp call to clean up cubes in memory after calling IsisMain.
2008-06-24 Steven Koechle - Added Preferences to Debugging Log.
2008-07-08 Steven Lambright - Singletons now destroy themselves instead of Application deleting them
2008-07-08 Steven Lambright - p_ui is no longer static, which fixes issues with the mac unit tests.
2009-11-19 Kris Becker - Made argc pass by reference since Qt's QApplication/QCoreApplication requires it
2010-03-17 Stuart Sides - Added the location of the Qt plugins into the library path
2010-06-29 Steven Lambright - Added a setlocale to english for numeric values
2010-11-29 Steven Lambright - Added the Version() method
2010-11-30 Steven Lambright - Merged some of the the "System" functions' functionality. Moved some of the inter-process communication to ProgramLauncher.
2011-03-01 Steven Lambright - Fixed Version method
2011-04-01 Eric Hyer - Now inherits from Environment
2011-07-12 Sharmila Prasad - Fixed bug in "ExecutionDateTime" keyword
2011-08-19 Jeannie Backer - Modified unitTest to use $temporary variable instead of /tmp directory. Added some documentation to methods.
2013-02-28 Janet Barrett - Needed to instantiate a QApplication in the constructor instead of a QCoreApplication so that Qt Gui is accessible by the command line. Also needed to define a compiler directive, USE_GUI_QAPP, to bypass a problem the Macs have with using QApplication. References #575.
Definition at line 112 of file Application.h.
Isis::Application::Application | ( | int & | argc, |
char * | argv[] | ||
) |
Constuctor for the Application object.
argc | Number of arguments in argv[]. This must be passed by reference!! |
*argv[] | An array containing the command line arguments |
Isis::iException::Io | - FileOpen error |
Definition at line 78 of file Application.cpp.
References _FILEINFO_, Isis::IException::errorType(), Isis::Message::FileOpen(), GetUserInterface(), Isis::UserInterface::ParentId(), Isis::IException::print(), and Isis::toString().
Isis::Application::~Application | ( | ) |
Destroys the Application object.
Definition at line 172 of file Application.cpp.
PvlGroup Isis::Application::Accounting | ( | ) |
Creates accounting PvlGroup.
Definition at line 287 of file Application.cpp.
|
static |
Returns the date and time as a QString.
*curtime |
Definition at line 809 of file Application.cpp.
|
private |
Returns the current number of I/O's.
Definition at line 334 of file Application.cpp.
|
private |
Cleans up after the function by writing the log, saving the history, and either sending the log to the parent if it has one, printing the log data to the terminal or showing the log in the gui.
Definition at line 542 of file Application.cpp.
References _FILEINFO_, and SendParentData().
Referenced by Isis::Gui::StartProcess().
|
private |
Adds the error to the session log, sends the error to the parent if it has one, loads the error message into the gui or prints it to the command line, gets the error type and returns it.
e | The Isis::iException |
Definition at line 633 of file Application.cpp.
References _FILEINFO_, Isis::IException::errorType(), Isis::IException::toPvl(), and Isis::IException::toString().
Referenced by Isis::Gui::StartProcess().
|
staticprivate |
Runs some printenv commands that return Isis related Enviroment Variables.
Definition at line 931 of file Application.cpp.
References Isis::PvlContainer::addKeyword().
|
inline |
helper |
Definition at line 140 of file Application.h.
Referenced by Isis::Gui::InvokeHelper().
|
staticprivate |
Runs ldd on linux and sun and otool on macs to get information about the applicaiton run.
Definition at line 1000 of file Application.cpp.
|
staticprivate |
Runs df to see the disk space availability.
Definition at line 973 of file Application.cpp.
|
staticprivate |
Runs various system specific uname commands and returns the results.
Definition at line 851 of file Application.cpp.
References Isis::PvlContainer::addKeyword().
|
static |
Returns the UserInterface object.
Definition at line 469 of file Application.cpp.
References p_ui.
Referenced by Isis::PipelineApplication::AddParameter(), Application(), Isis::ProcessByQuickFilter::GetFilterParameters(), GuiLog(), Isis::Gui::InvokeHelper(), Log(), Isis::Gui::ResetParameters(), SendParentData(), Isis::Pipeline::SetInputFile(), Isis::Pipeline::SetInputListFile(), Isis::ProcessExport::SetInputRange(), Isis::ProcessImport::SetOutputCube(), Isis::Pipeline::SetOutputFile(), Isis::Pipeline::SetOutputListFile(), Isis::Gui::ShowWarning(), Isis::Gui::StartProcess(), Isis::Gui::StopProcessing(), Isis::Gui::UpdateCommandLine(), and Isis::Gui::UpdateHistory().
|
static |
Writes the Pvl results to the sessionlog, but not to the printfile.
results | Pvl containing the results to add to the session log |
Definition at line 401 of file Application.cpp.
References GetUserInterface(), Isis::UserInterface::IsInteractive(), Isis::Gui::Log(), SendParentData(), and Isis::UserInterface::TheGui().
Referenced by Isis::ProgramLauncher::ProcessIsisMessageFromChild(), and Isis::GuiCubeParameter::ViewLabel().
|
static |
Writes the PvlGroup results to the sessionlog, but not to the printfile.
results | PvlGroup containing the results to add to the session log |
Definition at line 426 of file Application.cpp.
References GetUserInterface(), Isis::UserInterface::IsInteractive(), Isis::Gui::Log(), SendParentData(), and Isis::UserInterface::TheGui().
|
static |
Writes the results to the sessionlog, but not to the printfile.
results | QString containing the results to add to the session log |
Definition at line 451 of file Application.cpp.
References GetUserInterface(), Isis::UserInterface::IsInteractive(), Isis::Gui::Log(), SendParentData(), and Isis::UserInterface::TheGui().
void Isis::Application::GuiReportError | ( | IException & | e | ) |
Loads the error message into the gui, but does not write it to the session log.
e | The Isis::iException |
Definition at line 715 of file Application.cpp.
References Isis::IException::toString().
Referenced by Isis::Gui::InvokeHelper(), Isis::GuiCubeParameter::ViewCube(), and Isis::GuiCubeParameter::ViewLabel().
|
static |
Returns whether the application has a parent or not.
Definition at line 478 of file Application.cpp.
References p_ui, and Isis::UserInterface::ParentId().
PvlObject Isis::Application::History | ( | ) |
Creates an application history PvlObject.
Definition at line 258 of file Application.cpp.
References Isis::PvlObject::addGroup().
Referenced by Isis::History::AddEntry().
|
staticinherited |
Definition at line 71 of file Environment.cpp.
References Isis::Environment::getEnvironmentValue().
|
static |
Returns the host name.
Returns 'Unknown' if it cannot find the host name.
Definition at line 832 of file Application.cpp.
|
staticinherited |
Definition at line 99 of file Environment.cpp.
References _FILEINFO_, Isis::TextFile::GetLine(), and Isis::IException::Programmer.
|
static |
Writes Pvl results to sessionlog and printfile.
results | PvlGroup of results to add to the session log |
Definition at line 361 of file Application.cpp.
References GetUserInterface(), Isis::UserInterface::IsInteractive(), Isis::Gui::Log(), SendParentData(), and Isis::UserInterface::TheGui().
Referenced by Isis::ProgramLauncher::ProcessIsisMessageFromChild().
|
static |
Returns the name of the application.
Returns 'Unknown' if the application or gui equal NULL
Definition at line 736 of file Application.cpp.
Referenced by Isis::IException::toPvl().
|
private |
Returns the current number of faults.
Definition at line 343 of file Application.cpp.
|
private |
Processes the gui events.
If the event is cancel, it throws a cancel exception
Isis::iException::Cancel | - The event was cancelled |
Definition at line 793 of file Application.cpp.
Referenced by Isis::Progress::CheckStatus().
|
private |
Returns the current number of swaps.
Definition at line 352 of file Application.cpp.
|
inline |
int Isis::Application::Run | ( | void(*)() | funct | ) |
Runs the program defined in the function funct.
*funct |
Definition at line 185 of file Application.cpp.
References _FILEINFO_.
Referenced by main().
|
private |
code | |
message |
Definition at line 506 of file Application.cpp.
References _FILEINFO_, GetUserInterface(), Isis::UserInterface::ParentId(), and Isis::toString().
Referenced by FunctionCleanup(), GuiLog(), Log(), SendParentErrors(), and UpdateProgress().
|
private |
Sends errors to the parent.
&errors | A PvlObject of the errors |
Definition at line 490 of file Application.cpp.
References Isis::PvlObject::group(), Isis::PvlObject::groups(), and SendParentData().
|
inlineprivate |
p_connection |
Definition at line 192 of file Application.h.
|
private |
Updates the progress bar in the gui.
text | Progress text |
Definition at line 747 of file Application.cpp.
References SendParentData().
Referenced by Isis::Progress::CheckStatus(), and Isis::ProgramLauncher::ProcessIsisMessageFromChild().
|
private |
Updates the progress bar percent.
percent | The percent of the application that is complete |
Definition at line 769 of file Application.cpp.
References SendParentData(), and Isis::toString().
|
staticinherited |
the user name.
Returns 'Unknown' if it cannot find the user name.
Definition at line 63 of file Environment.cpp.
References Isis::Environment::getEnvironmentValue().
Referenced by Isis::Project::Project().
|
static |
Returns the user name.
Returns 'Unknown' if it cannot find the user name.
Definition at line 823 of file Application.cpp.
Referenced by Isis::QnetTool::addMeasure(), Isis::QnetTool::createFixedPoint(), Isis::StereoTool::createPoint(), Isis::MatchTool::createPoint(), Isis::QnetTool::createPoint(), Isis::MatchTool::measureSaved(), Isis::QnetTool::measureSaved(), Isis::QnetFileTool::open(), Isis::SocketThread::run(), and Isis::ControlPointEdit::saveMeasure().
|
static |
The Isis Version for this application.
Definition at line 841 of file Application.cpp.
|
private |
Pointer to a User Interface object.
Definition at line 169 of file Application.h.
Referenced by GetUserInterface(), and HasParent().