Isis 3.0 Programmer Reference
Back | Home
Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
Isis::Application Class Reference

#include <Application.h>

Inheritance diagram for Isis::Application:
Inheritance graph
Collaboration diagram for Isis::Application:
Collaboration graph

Public Member Functions

 Application (int &argc, char *argv[])
 Constuctor for the Application object. More...
 
 ~Application ()
 Destroys the Application object. More...
 
int Run (void(*funct)())
 Runs the program defined in the function funct. More...
 
PvlGroup Accounting ()
 Creates accounting PvlGroup. More...
 
PvlObject History ()
 Creates an application history PvlObject. More...
 
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. More...
 

Static Public Member Functions

static UserInterface & GetUserInterface ()
 Returns the UserInterface object. More...
 
static void Log (PvlGroup &results)
 Writes Pvl results to sessionlog and printfile. More...
 
static void GuiLog (const Pvl &results)
 Writes the Pvl results to the sessionlog, but not to the printfile. More...
 
static void GuiLog (const PvlGroup &results)
 Writes the PvlGroup results to the sessionlog, but not to the printfile. More...
 
static void GuiLog (const QString &results)
 Writes the results to the sessionlog, but not to the printfile. More...
 
static QString Name ()
 Returns the name of the application. More...
 
static QString UserName ()
 Returns the user name. More...
 
static QString HostName ()
 Returns the host name. More...
 
static QString DateTime (time_t *curtime=0)
 Returns the date and time as a QString. More...
 
static QString Version ()
 The Isis Version for this application. More...
 
static bool HasParent ()
 Returns whether the application has a parent or not. More...
 
static QString userName ()
 the user name. More...
 
static QString hostName ()
 
static QString isisVersion ()
 
static QString getEnvironmentValue (QString, QString)
 

Static Public Attributes

static bool p_applicationForceGuiApp = false
 

Private Member Functions

int DirectIO ()
 Returns the current number of I/O's. More...
 
int PageFaults ()
 Returns the current number of faults. More...
 
int ProcessSwaps ()
 Returns the current number of swaps. More...
 
void SendParentData (QString, const QString &)
 
void SendParentErrors (PvlObject &errors)
 Sends errors to the parent. More...
 
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. More...
 
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. More...
 
void UpdateProgress (const QString &text, bool print)
 Updates the progress bar in the gui. More...
 
void UpdateProgress (int percent, bool print)
 Updates the progress bar percent. More...
 
void ProcessGuiEvents ()
 Processes the gui events. More...
 
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. More...
 
static PvlGroup GetEnviromentInfo ()
 Runs some printenv commands that return Isis related Enviroment Variables. More...
 
static QString GetSystemDiskSpace ()
 Runs df to see the disk space availability. More...
 
static QString GetLibraryDependencies (QString file)
 Runs ldd on linux and sun and otool on macs to get information about the applicaiton run. More...
 

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. More...
 
pid_t p_pid
 
std::map< QString, void * > p_guiHelpers
 

Static Private Attributes

static QString p_appName
 

Friends

class Gui
 
class Progress
 
class ProgramLauncher
 

Detailed Description

Author
????-??-?? Unknown
History:

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.

2016-08-15 Adam Paquette - Reset locale after QApplication or QCoreApplication are instantiated. Fixes #3908.

Definition at line 114 of file Application.h.

Constructor & Destructor Documentation

Isis::Application::Application ( int &  argc,
char *  argv[] 
)

Constuctor for the Application object.

Parameters
argcNumber of arguments in argv[]. This must be passed by reference!!
*argv[]An array containing the command line arguments
Exceptions
Isis::iException::Io- FileOpen error

Definition at line 79 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 180 of file Application.cpp.

Member Function Documentation

PvlGroup Isis::Application::Accounting ( )

Creates accounting PvlGroup.

Returns
PvlGroup Accounting Group

Definition at line 296 of file Application.cpp.

QString Isis::Application::DateTime ( time_t *  curtime = 0)
static

Returns the date and time as a QString.

Parameters
*curtime
Returns
QString The date and time

Definition at line 817 of file Application.cpp.

int Isis::Application::DirectIO ( )
private

Returns the current number of I/O's.

Returns
int The current number of I/O's

Definition at line 343 of file Application.cpp.

void Isis::Application::FunctionCleanup ( )
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 551 of file Application.cpp.

References _FILEINFO_, and SendParentData().

Referenced by Isis::Gui::StartProcess().

int Isis::Application::FunctionError ( IException &  e)
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.

Parameters
eThe Isis::iException
Returns
int The Error Type

Definition at line 641 of file Application.cpp.

References _FILEINFO_, Isis::IException::errorType(), Isis::IException::toPvl(), and Isis::IException::toString().

Referenced by Isis::Gui::StartProcess().

PvlGroup Isis::Application::GetEnviromentInfo ( )
staticprivate

Runs some printenv commands that return Isis related Enviroment Variables.

Returns
PvlGroup containing Enviroment information
Todo:
Replace printenv commands with c library getenv

Definition at line 939 of file Application.cpp.

References Isis::PvlContainer::addKeyword().

QString Isis::Environment::getEnvironmentValue ( QString  variable,
QString  defaultValue 
)
staticinherited
Parameters
variableThe environment variable to get
defaultValueThe returned value for variable if variable doesn't exist.
Returns
The value for the environment variable requested.

Definition at line 122 of file Environment.cpp.

Referenced by Isis::Environment::hostName(), and Isis::Environment::userName().

void* Isis::Application::GetGuiHelper ( QString  helper)
inline
Parameters
helper

Definition at line 142 of file Application.h.

Referenced by Isis::Gui::InvokeHelper().

QString Isis::Application::GetLibraryDependencies ( QString  file)
staticprivate

Runs ldd on linux and sun and otool on macs to get information about the applicaiton run.

Returns
QString containing application information

Definition at line 1008 of file Application.cpp.

QString Isis::Application::GetSystemDiskSpace ( )
staticprivate

Runs df to see the disk space availability.

Returns
QString containing df results

Definition at line 981 of file Application.cpp.

PvlGroup Isis::Application::GetUnameInfo ( )
staticprivate

Runs various system specific uname commands and returns the results.

Returns
PvlGroup containing uname information

Definition at line 859 of file Application.cpp.

References Isis::PvlContainer::addKeyword().

Isis::UserInterface & Isis::Application::GetUserInterface ( )
static

Returns the UserInterface object.

Returns
A pointer to the UserInterface object

Definition at line 478 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().

void Isis::Application::GuiLog ( const Pvl &  results)
static

Writes the Pvl results to the sessionlog, but not to the printfile.

Parameters
resultsPvl containing the results to add to the session log

Definition at line 410 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().

void Isis::Application::GuiLog ( const PvlGroup &  results)
static

Writes the PvlGroup results to the sessionlog, but not to the printfile.

Parameters
resultsPvlGroup containing the results to add to the session log

Definition at line 435 of file Application.cpp.

References GetUserInterface(), Isis::UserInterface::IsInteractive(), Isis::Gui::Log(), SendParentData(), and Isis::UserInterface::TheGui().

void Isis::Application::GuiLog ( const QString &  results)
static

Writes the results to the sessionlog, but not to the printfile.

Parameters
resultsQString containing the results to add to the session log

Definition at line 460 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.

Parameters
eThe Isis::iException

Definition at line 723 of file Application.cpp.

References Isis::IException::toString().

Referenced by Isis::Gui::InvokeHelper(), Isis::GuiCubeParameter::ViewCube(), and Isis::GuiCubeParameter::ViewLabel().

bool Isis::Application::HasParent ( )
static

Returns whether the application has a parent or not.

Returns
bool Returns true if it has a parent, and false if it does not

Definition at line 487 of file Application.cpp.

References p_ui, and Isis::UserInterface::ParentId().

PvlObject Isis::Application::History ( )

Creates an application history PvlObject.

Returns
PvlObject

Definition at line 267 of file Application.cpp.

References Isis::PvlObject::addGroup().

Referenced by Isis::History::AddEntry().

QString Isis::Environment::hostName ( )
staticinherited
Returns
the host name. Returns 'Unknown' if it cannot find the host name.

Definition at line 110 of file Environment.cpp.

References Isis::Environment::getEnvironmentValue().

QString Isis::Application::HostName ( )
static

Returns the host name.

Returns 'Unknown' if it cannot find the host name.

Returns
QString Host Name

Definition at line 840 of file Application.cpp.

QString Isis::Environment::isisVersion ( )
staticinherited
Returns
the Isis version in the format isis?.?.?.?qualifier | date

Definition at line 138 of file Environment.cpp.

References _FILEINFO_, Isis::TextFile::GetLine(), and Isis::IException::Programmer.

void Isis::Application::Log ( PvlGroup &  results)
static

Writes Pvl results to sessionlog and printfile.

Parameters
resultsPvlGroup of results to add to the session log

Definition at line 370 of file Application.cpp.

References GetUserInterface(), Isis::UserInterface::IsInteractive(), Isis::Gui::Log(), SendParentData(), and Isis::UserInterface::TheGui().

Referenced by Isis::ProgramLauncher::ProcessIsisMessageFromChild().

QString Isis::Application::Name ( )
static

Returns the name of the application.

Returns 'Unknown' if the application or gui equal NULL

Returns
QString The application name

Definition at line 744 of file Application.cpp.

Referenced by Isis::IException::toPvl().

int Isis::Application::PageFaults ( )
private

Returns the current number of faults.

Returns
The current number of page faults

Definition at line 352 of file Application.cpp.

void Isis::Application::ProcessGuiEvents ( )
private

Processes the gui events.

If the event is cancel, it throws a cancel exception

Exceptions
Isis::iException::Cancel- The event was cancelled

Definition at line 801 of file Application.cpp.

Referenced by Isis::Progress::CheckStatus().

int Isis::Application::ProcessSwaps ( )
private

Returns the current number of swaps.

Returns
The current number of process swaps

Definition at line 361 of file Application.cpp.

void Isis::Application::RegisterGuiHelpers ( std::map< QString, void * >  helpers)
inline
Parameters
helpers

Definition at line 135 of file Application.h.

int Isis::Application::Run ( void(*)()  funct)

Runs the program defined in the function funct.

Parameters
*funct
Returns
int Status of the function execution

Definition at line 194 of file Application.cpp.

References _FILEINFO_.

void Isis::Application::SendParentData ( QString  code,
const QString &  message 
)
private
Parameters
code
message

Definition at line 515 of file Application.cpp.

References _FILEINFO_, GetUserInterface(), Isis::UserInterface::ParentId(), and Isis::toString().

Referenced by FunctionCleanup(), GuiLog(), Log(), SendParentErrors(), and UpdateProgress().

void Isis::Application::SendParentErrors ( Isis::PvlObject &  errors)
private

Sends errors to the parent.

Parameters
&errorsA PvlObject of the errors

Definition at line 499 of file Application.cpp.

References Isis::PvlObject::group(), Isis::PvlObject::groups(), and SendParentData().

void Isis::Application::SetParentConnection ( QLocalSocket *  p_connection)
inlineprivate
Parameters
p_connection

Definition at line 194 of file Application.h.

void Isis::Application::UpdateProgress ( const QString &  text,
bool  print 
)
private

Updates the progress bar in the gui.

Parameters
textProgress text
print

Definition at line 755 of file Application.cpp.

References SendParentData().

Referenced by Isis::Progress::CheckStatus(), and Isis::ProgramLauncher::ProcessIsisMessageFromChild().

void Isis::Application::UpdateProgress ( int  percent,
bool  print 
)
private

Updates the progress bar percent.

Parameters
percentThe percent of the application that is complete
print

Definition at line 777 of file Application.cpp.

References SendParentData(), and Isis::toString().

QString Isis::Environment::userName ( )
staticinherited

the user name.

Returns 'Unknown' if it cannot find the user name.

Definition at line 102 of file Environment.cpp.

References Isis::Environment::getEnvironmentValue().

Referenced by Isis::Project::Project().

QString Isis::Application::UserName ( )
static

Returns the user name.

Returns 'Unknown' if it cannot find the user name.

Returns
QString User Name

Definition at line 831 of file Application.cpp.

Referenced by Isis::QnetTool::addMeasure(), Isis::QnetTool::createFixedPoint(), Isis::StereoTool::createPoint(), Isis::MatchTool::createPoint(), Isis::QnetTool::createPoint(), Isis::ControlPointEditWidget::measureSaved(), Isis::MatchTool::measureSaved(), Isis::QnetTool::measureSaved(), Isis::QnetFileTool::open(), Isis::SocketThread::run(), Isis::ControlPointEdit::saveMeasure(), and Isis::ControlMeasureEditWidget::saveMeasure().

QString Isis::Application::Version ( )
static

The Isis Version for this application.

Returns
QString

Definition at line 849 of file Application.cpp.

Member Data Documentation

UserInterface* Isis::Application::p_ui
private

Pointer to a User Interface object.

Definition at line 171 of file Application.h.

Referenced by GetUserInterface(), and HasParent().

The documentation for this class was generated from the following files:
U.S. Department of the Interior | U.S. Geological Survey
ISIS | Privacy & Disclaimers | Astrogeology Research Program
To contact us, please post comments and questions on the ISIS Support Center
File Modified: 07/12/2023 23:33:26