Isis::Application Class Reference

#include <Application.h>

Inheritance diagram for Isis::Application:

Collaboration diagram for Isis::Application:

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	AppendAndLog (PvlGroup &results, Pvl *log)
	Writes the pvl group results to both a passed in Pvl log and the applications log (either GUI or command line)
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	formatError (IException &e)
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 QString	AleVersion ()
	The Ale Version for this application.
static bool	HasParent ()
	Returns whether the application has a parent or not.
static QString	userName ()
	@Returns the user name.
static QString	hostName ()
static QString	isisVersion ()
static QString	aleVersion ()
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.
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 ()
	Returns 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
QElapsedTimer	m_connectTime
	Used to calculate program's run time.
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
static Environment	automaticEnvironmentSetup
	Construct an environment in static space to initialize some global Isis environment options.

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.

2017-06-08 Christopher Combs - Changed object used to calculate connectTime from a time_t to a QTime. Fixes #4618.

Definition at line 101 of file Application.h.

Constructor & Destructor Documentation

Application()

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

Constuctor for the Application object.

Parameters

argc	Number 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 60 of file Application.cpp.

References DateTime(), DirectIO(), GetUserInterface(), m_connectTime, p_ui, PageFaults(), ProcessSwaps(), Isis::toString(), and UserName().

~Application()

Isis::Application::~Application

(

)

Destroys the Application object.

Definition at line 169 of file Application.cpp.

References p_ui.

Member Function Documentation

Accounting()

PvlGroup Isis::Application::Accounting

(

)

Creates accounting PvlGroup.

Returns

PvlGroup Accounting Group

Definition at line 288 of file Application.cpp.

References m_connectTime.

AleVersion()

QString Isis::Application::AleVersion ( )

static

The Ale Version for this application.

Returns

QString

Definition at line 895 of file Application.cpp.

References Isis::Environment::aleVersion().

Referenced by History().

aleVersion()

QString Isis::Environment::aleVersion ( )

staticinherited

Returns

the Ale version extracted from the conda environment

Definition at line 148 of file Environment.cpp.

References Isis::TextFile::GetLine().

Referenced by Isis::Application::AleVersion().

AppendAndLog()

void Isis::Application::AppendAndLog ( PvlGroup & results, Pvl * log )

static

Writes the pvl group results to both a passed in Pvl log and the applications log (either GUI or command line)

Parameters

results	Pvl containing the results to add to the session log
log	App log for running in code

Definition at line 406 of file Application.cpp.

References Log().

DateTime()

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 854 of file Application.cpp.

Referenced by Application(), Isis::ControlNet::ControlNet(), Isis::ControlMeasure::GetDateTime(), History(), Isis::ProcessExportPds4::identificationArea(), Run(), and Isis::ControlMeasure::SetDateTime().

DirectIO()

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 333 of file Application.cpp.

Referenced by Application(), and Run().

formatError()

QString Isis::Application::formatError ( IException & e )

static

Definition at line 751 of file Application.cpp.

FunctionCleanup()

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 559 of file Application.cpp.

References GetEnviromentInfo(), GetLibraryDependencies(), GetSystemDiskSpace(), GetUnameInfo(), HasParent(), and p_ui.

Referenced by Run().

FunctionError()

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

e	The Isis::iException

Returns

int The Error Type

Definition at line 649 of file Application.cpp.

References GetEnviromentInfo(), GetLibraryDependencies(), GetSystemDiskSpace(), GetUnameInfo(), HasParent(), Name(), p_ui, and SendParentErrors().

Referenced by Run().

GetEnviromentInfo()

PvlGroup Isis::Application::GetEnviromentInfo ( )

staticprivate

Returns ISIS-related Enviroment Variables.

Returns

PvlGroup containing Enviroment information

Definition at line 983 of file Application.cpp.

Referenced by FunctionCleanup(), and FunctionError().

getEnvironmentValue()

QString Isis::Environment::getEnvironmentValue ( QString variable, QString defaultValue )

staticinherited

Parameters

variable	The environment variable to get
defaultValue	The returned value for variable if variable doesn't exist.

Returns

The value for the environment variable requested.

Definition at line 93 of file Environment.cpp.

Referenced by hostName(), and userName().

GetGuiHelper()

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

inline

Parameters

helper

Definition at line 131 of file Application.h.

GetLibraryDependencies()

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 1029 of file Application.cpp.

References Isis::ProgramLauncher::RunSystemCommand().

Referenced by FunctionCleanup(), and FunctionError().

GetSystemDiskSpace()

QString Isis::Application::GetSystemDiskSpace ( )

staticprivate

Runs df to see the disk space availability.

Returns

QString containing df results

Definition at line 1002 of file Application.cpp.

References Isis::ProgramLauncher::RunSystemCommand().

Referenced by FunctionCleanup(), and FunctionError().

GetUnameInfo()

PvlGroup Isis::Application::GetUnameInfo ( )

staticprivate

Runs various system specific uname commands and returns the results.

Returns

PvlGroup containing uname information

Definition at line 905 of file Application.cpp.

References Isis::ProgramLauncher::RunSystemCommand().

Referenced by FunctionCleanup(), and FunctionError().

GetUserInterface()

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

static

Returns the UserInterface object.

Returns

A pointer to the UserInterface object

Definition at line 486 of file Application.cpp.

Referenced by Isis::PipelineApplication::AddParameter(), Isis::PipelineApplication::AddParameter(), Application(), Isis::ProcessByQuickFilter::GetFilterParameters(), Isis::Gui::InvokeHelper(), Isis::Gui::ResetParameters(), Isis::Process::SetInputCube(), Isis::Pipeline::SetInputFile(), Isis::Pipeline::SetInputFile(), Isis::Pipeline::SetInputListFile(), Isis::ProcessExport::SetInputRange(), Isis::Process::SetOutputCube(), Isis::ProcessImport::SetOutputCube(), Isis::ProcessMosaic::SetOutputCube(), Isis::Process::SetOutputCubeStretch(), Isis::Pipeline::SetOutputFile(), Isis::Pipeline::SetOutputListFile(), Isis::ProcessGroundPolygons::SetStatCubes(), Isis::ProcessGroundPolygons::SetStatCubes(), Isis::ProcessPolygons::SetStatCubes(), Isis::Gui::StopProcessing(), Isis::Gui::UpdateCommandLine(), and Isis::Gui::UpdateHistory().

GuiLog() [1/3]

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

static

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

Parameters

results

Pvl containing the results to add to the session log

Definition at line 418 of file Application.cpp.

References HasParent().

Referenced by Isis::GuiCubeParameter::ViewLabel().

GuiLog() [2/3]

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

static

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

Parameters

results

PvlGroup containing the results to add to the session log

Definition at line 443 of file Application.cpp.

References HasParent().

GuiLog() [3/3]

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

static

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

Parameters

results

QString containing the results to add to the session log

Definition at line 468 of file Application.cpp.

References HasParent().

GuiReportError()

void Isis::Application::GuiReportError

(

IException &

e

)

Loads the error message into the gui, but does not write it to the session log.

Parameters

e	The Isis::iException

Definition at line 737 of file Application.cpp.

References p_ui.

HasParent()

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 495 of file Application.cpp.

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

History()

PvlObject Isis::Application::History

(

)

Creates an application history PvlObject.

Returns

PvlObject

Definition at line 257 of file Application.cpp.

References AleVersion(), DateTime(), HostName(), m_connectTime, p_ui, UserName(), and Version().

HostName()

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 877 of file Application.cpp.

References Isis::Environment::hostName().

Referenced by History().

hostName()

QString Isis::Environment::hostName ( )

staticinherited

Returns

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

Definition at line 81 of file Environment.cpp.

References getEnvironmentValue().

Referenced by Isis::Application::HostName().

isisVersion()

QString Isis::Environment::isisVersion ( )

staticinherited

Returns

the Isis version in the format isis?.?.?.?qualifier | date

Definition at line 109 of file Environment.cpp.

References Isis::TextFile::GetLine().

Referenced by Isis::Application::Version().

Log()

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

static

Writes Pvl results to sessionlog and printfile.

Parameters

results

PvlGroup of results to add to the session log

Definition at line 360 of file Application.cpp.

References HasParent().

Referenced by AppendAndLog(), and Isis::BundleAdjust::iterationSummary().

Name()

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 781 of file Application.cpp.

Referenced by FunctionError(), Isis::ControlMeasure::GetChooserName(), and Isis::ProcessExportPds4::identificationArea().

PageFaults()

int Isis::Application::PageFaults ( )

private

Returns the current number of faults.

Returns

The current number of page faults

Definition at line 342 of file Application.cpp.

Referenced by Application(), and Run().

ProcessGuiEvents()

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 838 of file Application.cpp.

References p_ui.

Referenced by UpdateProgress().

ProcessSwaps()

int Isis::Application::ProcessSwaps ( )

private

Returns the current number of swaps.

Returns

The current number of process swaps

Definition at line 351 of file Application.cpp.

Referenced by Application(), and Run().

RegisterGuiHelpers()

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

inline

Parameters

helpers

Definition at line 124 of file Application.h.

Run()

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 183 of file Application.cpp.

References DateTime(), DirectIO(), FunctionCleanup(), FunctionError(), m_connectTime, p_ui, PageFaults(), and ProcessSwaps().

SendParentData()

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

private

Parameters

code
message

Definition at line 523 of file Application.cpp.

References Isis::toString().

SendParentErrors()

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

private

Sends errors to the parent.

Parameters

&errors

A PvlObject of the errors

Definition at line 507 of file Application.cpp.

References HasParent().

Referenced by FunctionError().

SetParentConnection()

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

inlineprivate

Parameters

p_connection

Definition at line 185 of file Application.h.

UpdateProgress() [1/2]

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

private

Updates the progress bar in the gui.

Parameters

text	Progress text
print

Definition at line 792 of file Application.cpp.

References HasParent(), p_ui, and ProcessGuiEvents().

UpdateProgress() [2/2]

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

private

Updates the progress bar percent.

Parameters

percent	The percent of the application that is complete
print

Definition at line 814 of file Application.cpp.

References HasParent(), p_ui, and Isis::toString().

UserName()

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 868 of file Application.cpp.

References Isis::Environment::userName().

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

userName()

QString Isis::Environment::userName ( )

staticinherited

@Returns the user name.

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

Definition at line 73 of file Environment.cpp.

References getEnvironmentValue().

Referenced by Isis::Project::clear(), Isis::Project::Project(), and Isis::Application::UserName().

Version()

QString Isis::Application::Version ( )

static

The Isis Version for this application.

Returns

QString

Definition at line 886 of file Application.cpp.

References Isis::Environment::isisVersion().

Referenced by History(), and Isis::ProcessExportPds4::identificationArea().

Friends And Related Symbol Documentation

Gui

friend class Gui

friend

Definition at line 172 of file Application.h.

ProgramLauncher

friend class ProgramLauncher

friend

Definition at line 177 of file Application.h.

Progress

friend class Progress

friend

Definition at line 176 of file Application.h.

Member Data Documentation

automaticEnvironmentSetup

Environment Isis::Environment::automaticEnvironmentSetup

staticprivateinherited

Construct an environment in static space to initialize some global Isis environment options.

This initialization applies to anything that links against the Isis library.

Definition at line 56 of file Environment.h.

m_connectTime

QElapsedTimer Isis::Application::m_connectTime

private

Used to calculate program's run time.

Definition at line 154 of file Application.h.

Referenced by Accounting(), Application(), History(), and Run().

p_applicationForceGuiApp

bool Isis::Application::p_applicationForceGuiApp = false

static

Definition at line 119 of file Application.h.

p_appName

QString Isis::Application::p_appName

staticprivate

Definition at line 193 of file Application.h.

p_BatchlistPass

int Isis::Application::p_BatchlistPass

private

Definition at line 146 of file Application.h.

p_childCaught

bool Isis::Application::p_childCaught

private

Definition at line 160 of file Application.h.

p_childPid

pid_t Isis::Application::p_childPid

private

Definition at line 159 of file Application.h.

p_connectionToParent

QLocalSocket* Isis::Application::p_connectionToParent

private

Definition at line 151 of file Application.h.

p_datetime

QString Isis::Application::p_datetime

private

Definition at line 155 of file Application.h.

p_guiHelpers

std::map<QString, void *> Isis::Application::p_guiHelpers

private

Definition at line 192 of file Application.h.

p_pid

pid_t Isis::Application::p_pid

private

Definition at line 191 of file Application.h.

p_startClock

clock_t Isis::Application::p_startClock

private

Definition at line 153 of file Application.h.

p_startDirectIO

int Isis::Application::p_startDirectIO

private

Definition at line 156 of file Application.h.

p_startPageFaults

int Isis::Application::p_startPageFaults

private

Definition at line 157 of file Application.h.

p_startProcessSwaps

int Isis::Application::p_startProcessSwaps

private

Definition at line 158 of file Application.h.

p_startTime

time_t Isis::Application::p_startTime

private

Definition at line 152 of file Application.h.

p_ui

UserInterface* Isis::Application::p_ui

private

Pointer to a User Interface object.

Definition at line 162 of file Application.h.

Referenced by Application(), FunctionCleanup(), FunctionError(), GuiReportError(), History(), ProcessGuiEvents(), Run(), UpdateProgress(), UpdateProgress(), and ~Application().

---

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

• src/base/objs/Application/Application.h
• src/base/objs/Application/Application.cpp