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 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	getEnvironmentValue (QString, QString)

Static Public Attributes
static bool	p_applicationForceGuiApp = false

Friends
class	Gui
class	Progress
class	ProgramLauncher

Detailed Description

Author

????-??-?? Unknown

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

References _FILEINFO_, DateTime(), Isis::IException::errorType(), Isis::FileName::expanded(), Isis::FileName::fileExists(), Isis::Message::FileOpen(), GetUserInterface(), Isis::iApp, Isis::IException::Io, Isis::FileName::name(), p_applicationForceGuiApp, Isis::Preference::Preferences(), Isis::IException::print(), Isis::toString(), and UserName().

~Application()

Isis::Application::~Application

(

)

Destroys the Application object.

Member Function Documentation

Accounting()

PvlGroup Isis::Application::Accounting

(

)

Creates accounting PvlGroup.

Returns

PvlGroup Accounting Group

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

References Isis::PvlObject::addGroup(), and 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

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

formatError()

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

static

References Isis::PvlObject::clear(), Isis::PvlObject::group(), Isis::PvlObject::groups(), Isis::PvlContainer::isNamed(), Name(), Isis::Preference::Preferences(), and Isis::IException::toString().

Referenced by GuiReportError().

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.

Referenced by Environment(), hostName(), QStartup(), and userName().

GetGuiHelper()

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

inline

Parameters

helper

GetUserInterface()

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

static

Returns the UserInterface object.

Returns

A pointer to the UserInterface object

References Isis::iApp.

Referenced by Isis::PipelineApplication::AddParameter(), Isis::PipelineApplication::AddParameter(), Application(), 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(), and Isis::ProcessPolygons::SetStatCubes().

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

References HasParent(), and Isis::iApp.

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

References HasParent(), and Isis::iApp.

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

References HasParent(), and Isis::iApp.

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

References formatError().

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

References Isis::iApp.

Referenced by GuiLog(), GuiLog(), GuiLog(), and Log().

History()

PvlObject Isis::Application::History

(

)

Creates an application history PvlObject.

Returns

PvlObject

References Isis::PvlObject::addGroup(), DateTime(), Isis::PvlObject::findGroup(), HostName(), 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

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.

References getEnvironmentValue().

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

isisVersion()

QString Isis::Environment::isisVersion ( )

staticinherited

Returns

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

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

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

References Isis::SessionLog::AddResults(), HasParent(), Isis::iApp, and Isis::SessionLog::TheLog().

Referenced by AppendAndLog().

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

Referenced by formatError(), Isis::ControlMeasure::GetChooserName(), Isis::ControlPoint::GetChooserName(), Isis::ProcessExportPds4::identificationArea(), and Isis::IException::toPvl().

RegisterGuiHelpers()

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

inline

Parameters

helpers

Referenced by main().

Run()

int Isis::Application::Run

(

void(*

funct )()

)

Runs the program defined in the function funct.

Parameters

*funct

Returns

int Status of the function execution

References _FILEINFO_, DateTime(), Isis::SessionLog::TheLog(), and Isis::IException::what().

Referenced by main().

UserName()

QString Isis::Application::UserName ( )

static

Returns the user name.

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

Returns

QString User Name

References Isis::Environment::userName().

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

userName()

QString Isis::Environment::userName ( )

staticinherited

@Returns the user name.

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

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

References Isis::Environment::isisVersion().

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

Friends And Related Symbol Documentation

Gui

friend class Gui

friend

References Gui.

Referenced by Gui.

ProgramLauncher

friend class ProgramLauncher

friend

References ProgramLauncher.

Referenced by ProgramLauncher.

Progress

friend class Progress

friend

References Progress.

Referenced by Progress.

Member Data Documentation

p_applicationForceGuiApp

bool Isis::Application::p_applicationForceGuiApp = false

static

Referenced by Application(), and main().

---

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

• /Users/astamile/ISIS3/isis/src/base/objs/Application/Application.h
• /Users/astamile/ISIS3/isis/src/base/objs/Application/Application.cpp