#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. 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 ()
	@Returns 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

QTime	m_connectTime
	Used to calculate program's run time. More...

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

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

Friends
class	Gui

class	Progress

class	ProgramLauncher

Detailed Description

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

History:: 2005-12-16 Elizabeth Miller - Added documentation and -BATCHLIST capabilities

History:: 2006-02-13 Elizabeth Miller - Added GuiHelper Capabilities

History:: 2006-02-16 Jeff Anderson - Fixed race condition on sockets between communicating ISIS programs

History:: 2006-02-17 Fixed bug with application name being unknown if the user interface threw an error

History:: 2006-02-27 Elizabeth Miller - Added GuiLog and GuiReportError methods

History:: 2006-07-28 Jeff Anderson - Fixed another race condition with sockets between communicating ISIS programs. Also updated progress to output name of the program

History:: 2006-08-30 Jeff Anderson - Create a QCoreApplication if in command line mode.

History:: 2007-10-04 Steven Koechle - Added output capability for debugging log for -info flag

History:: 2008-01-04 Jeannie Walldren - Changed description of Log method

History:: 2008-01-09 Steven Lambright - Fixed Memory Leak

History:: 2008-04-16 Steven Lambright - Added parameter check that was removed from UserInterface

History:: 2008-06-18 Christopher Austin - Fixed documentation error

History:: 2008-06-19 Steven Lambright - Added CubeManager::CleanUp call to clean up cubes in memory after calling IsisMain.

History:: 2008-06-24 Steven Koechle - Added Preferences to Debugging Log.

History:: 2008-07-08 Steven Lambright - Singletons now destroy themselves instead of Application deleting them

History:: 2008-07-08 Steven Lambright - p_ui is no longer static, which fixes issues with the mac unit tests.

History:: 2009-11-19 Kris Becker - Made argc pass by reference since Qt's QApplication/QCoreApplication requires it

History:: 2010-03-17 Stuart Sides - Added the location of the Qt plugins into the library path

History:: 2010-06-29 Steven Lambright - Added a setlocale to english for numeric values

History:: 2010-11-29 Steven Lambright - Added the Version() method

History:: 2010-11-30 Steven Lambright - Merged some of the the "System" functions' functionality. Moved some of the inter-process communication to ProgramLauncher.

History:: 2011-03-01 Steven Lambright - Fixed Version method

History:: 2011-04-01 Eric Hyer - Now inherits from Environment

History:: 2011-07-12 Sharmila Prasad - Fixed bug in "ExecutionDateTime" keyword

History:: 2011-08-19 Jeannie Backer - Modified unitTest to use $temporary variable instead of /tmp directory. Added some documentation to methods.

History:: 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.

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

History:: 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 64 of file Application.cpp.

References Isis::IException::errorType(), Isis::FileName::expanded(), Isis::FileName::fileExists(), GetUserInterface(), Isis::FileName::name(), Isis::UserInterface::ParentId(), Isis::IException::print(), and Isis::toString().

◆ ~Application()

Isis::Application::~Application ( )

Destroys the Application object.

Definition at line 163 of file Application.cpp.

Member Function Documentation

◆ Accounting()

PvlGroup Isis::Application::Accounting ( )

Creates accounting PvlGroup.

Returns: PvlGroup Accounting Group

Definition at line 281 of file Application.cpp.

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

◆ 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 326 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 536 of file Application.cpp.

References SendParentData().

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

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

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

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

◆ GetEnviromentInfo()

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

Todo:

Definition at line 924 of file Application.cpp.

References Isis::PvlContainer::addKeyword(), and Isis::FileName::expanded().

◆ 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 92 of file Environment.cpp.

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

◆ GetGuiHelper()

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

inline

Parameters

helper

Definition at line 129 of file Application.h.

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

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

References Isis::FileName::expanded().

◆ GetSystemDiskSpace()

QString Isis::Application::GetSystemDiskSpace ( )

staticprivate

Runs df to see the disk space availability.

Returns: QString containing df results

Definition at line 966 of file Application.cpp.

References Isis::FileName::expanded().

◆ GetUnameInfo()

PvlGroup Isis::Application::GetUnameInfo ( )

staticprivate

Runs various system specific uname commands and returns the results.

Returns: PvlGroup containing uname information

Definition at line 844 of file Application.cpp.

References Isis::PvlContainer::addKeyword(), and Isis::FileName::expanded().

◆ GetUserInterface()

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

static

Returns the UserInterface object.

Returns: A pointer to the UserInterface object

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

◆ 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 395 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().

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

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

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

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

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

References Isis::IException::toString().

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

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

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

◆ History()

PvlObject Isis::Application::History ( )

Creates an application history PvlObject.

Returns: PvlObject

Definition at line 251 of file Application.cpp.

References Isis::PvlObject::addGroup(), and Isis::PvlObject::findGroup().

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

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

◆ hostName()

QString Isis::Environment::hostName ( )

staticinherited

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

Definition at line 80 of file Environment.cpp.

References Isis::Environment::getEnvironmentValue().

◆ isisVersion()

QString Isis::Environment::isisVersion ( )

staticinherited

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

Definition at line 108 of file Environment.cpp.

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

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

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

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

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

Referenced by Isis::Pipeline::Run(), and Isis::IException::toPvl().

◆ PageFaults()

int Isis::Application::PageFaults ( )

private

Returns the current number of faults.

Returns: The current number of page faults

Definition at line 335 of file Application.cpp.

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

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

◆ ProcessSwaps()

int Isis::Application::ProcessSwaps ( )

private

Returns the current number of swaps.

Returns: The current number of process swaps

Definition at line 344 of file Application.cpp.

◆ RegisterGuiHelpers()

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

inline

Parameters

helpers

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

◆ SendParentData()

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

private

Parameters

code
message

Definition at line 500 of file Application.cpp.

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

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

◆ SendParentErrors()

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

private

Sends errors to the parent.

Parameters

&errors A PvlObject of the errors

Definition at line 484 of file Application.cpp.

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

◆ SetParentConnection()

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

inlineprivate

Parameters

p_connection

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

References SendParentData().

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

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

References SendParentData(), 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 816 of file Application.cpp.

Referenced by Isis::QnetTool::addMeasure(), Isis::ControlPointEditWidget::createControlPoint(), Isis::QnetTool::createFixedPoint(), Isis::QnetTool::createPoint(), Isis::StereoTool::createPoint(), Isis::MatchTool::createPoint(), Isis::ControlPointEditWidget::measureSaved(), Isis::MatchTool::measureSaved(), Isis::QnetTool::measureSaved(), Isis::QnetFileTool::open(), Isis::SocketThread::run(), 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 72 of file Environment.cpp.

References Isis::Environment::getEnvironmentValue().

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

◆ Version()

QString Isis::Application::Version ( )

static

The Isis Version for this application.

Returns: QString

Definition at line 834 of file Application.cpp.

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 55 of file Environment.h.

◆ m_connectTime

QTime Isis::Application::m_connectTime

private

Used to calculate program's run time.

Definition at line 151 of file Application.h.

◆ p_ui

UserInterface* Isis::Application::p_ui

private

Pointer to a User Interface object.

Definition at line 159 of file Application.h.

Referenced by GetUserInterface(), and HasParent().

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

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Application()

◆ ~Application()

Member Function Documentation

◆ Accounting()

◆ DateTime()

◆ DirectIO()

◆ FunctionCleanup()

◆ FunctionError()

◆ GetEnviromentInfo()

◆ getEnvironmentValue()

◆ GetGuiHelper()

◆ GetLibraryDependencies()

◆ GetSystemDiskSpace()

◆ GetUnameInfo()

◆ GetUserInterface()

◆ GuiLog() [1/3]

◆ GuiLog() [2/3]

◆ GuiLog() [3/3]

◆ GuiReportError()

◆ HasParent()

◆ History()

◆ HostName()

◆ hostName()

◆ isisVersion()

◆ Log()

◆ Name()

◆ PageFaults()

◆ ProcessGuiEvents()

◆ ProcessSwaps()

◆ RegisterGuiHelpers()

◆ Run()

◆ SendParentData()

◆ SendParentErrors()

◆ SetParentConnection()

◆ UpdateProgress() [1/2]

◆ UpdateProgress() [2/2]

◆ UserName()

◆ userName()

◆ Version()

Member Data Documentation

◆ automaticEnvironmentSetup

◆ m_connectTime

◆ p_ui