Isis::UserInterface Class Reference
[Application Interface]

Command Line and Xml loader, validation, and access. More...

#include <UserInterface.h>

Inheritance diagram for Isis::UserInterface:

[legend]

Collaboration diagram for Isis::UserInterface:

[legend]

List of all members.

Public Member Functions
	UserInterface (const QString &xmlfile, int &argc, char *argv[])
	Constructs an UserInterface object.
	~UserInterface ()
	Destroys the UserInterface object.
bool	IsInteractive ()
	Indicates if the Isis Graphical User Interface is operating.
Gui *	TheGui ()
int	BatchListSize ()
	Returns the size of the batchlist.
int	ParentId ()
	Returns the parent id.
bool	AbortOnError ()
	Returns true if the program should abort on error, and false if it should continue.
void	SaveHistory ()
	Saves the user parameter information in the history of the program for later use.
void	SetBatchList (int i)
	Clears the gui parameters and sets the batch list information at line i as the new parameters.
void	SetErrorList (int i)
	This method adds the line specified in the BatchList that the error occured on.
bool	GetInfoFlag ()
	This method returns the flag state of info.
QString	GetInfoFileName ()
	This method returns the filename where the debugging info is stored when the "-info" tag is used.
void	PutAsString (const QString &paramName, const QString &value)
	Allows the insertion of a value for any parameter.
void	PutAsString (const QString &paramName, const std::vector< QString > &value)
void	PutFileName (const QString &paramName, const QString &value)
	Allows the insertion of a value for a parameter of type "filename".
void	PutFileName (const QString &paramName, const std::vector< QString > &value)
void	PutDouble (const QString &paramName, const double &value)
	Allows the insertion of a value for a parameter of type "double".
void	PutDouble (const QString &paramName, const std::vector< double > &value)
void	PutInteger (const QString &paramName, const int &value)
	Allows the insertion of a value for a parameter of type "integer".
void	PutInteger (const QString &paramName, const std::vector< int > &value)
void	PutBoolean (const QString &paramName, const bool &value)
	Allows the insertion of a value for a parameter of type "boolean".
void	PutBoolean (const QString &paramName, const std::vector< bool > &value)
void	PutString (const QString &paramName, const QString &value)
	Allows the insertion of a value for any parameter.
void	PutString (const QString &paramName, const std::vector< QString > &value)
QString	GetAsString (const QString &paramName) const
	Allows the retrieval of a value for a parameter of any type.
void	GetAsString (const QString &paramName, std::vector< QString > &values) const
QString	GetFileName (const QString &paramName, QString extension="") const
	Allows the retrieval of a value for a parameter of type "filename".
void	GetFileName (const QString &paramName, std::vector< QString > &values) const
QString	GetString (const QString &paramName) const
	Allows the retrieval of a value for a parameter of type "string".
void	GetString (const QString &paramName, std::vector< QString > &values) const
int	GetInteger (const QString &paramName) const
	Allows the retrieval of a value for a parameter of type "integer".
void	GetInteger (const QString &paramName, std::vector< int > &values) const
bool	GetBoolean (const QString &paramName) const
	Allows the retrieval of a value for a parameter of type "boolean".
void	GetBoolean (const QString &paramName, std::vector< bool > &values) const
double	GetDouble (const QString &paramName) const
	Allows the retrieval of a value for a parameter of type "double".
void	GetDouble (const QString &paramName, std::vector< double > &values) const
bool	WasEntered (const QString &paramName) const
	Returns a true if the parameter has a value, and false if it does not.
void	Clear (const QString &paramName)
	Clears the value(s) in the named parameter.
Isis::CubeAttributeInput &	GetInputAttribute (const QString &paramName)
	Gets the attributes for an input cube.
Isis::CubeAttributeOutput &	GetOutputAttribute (const QString &paramName)
	Gets the attributes for an output cube.
QString	ProgramName () const
	Returns the Program name.
QString	Brief () const
	Returns the brief description of the program.
QString	Description () const
	Returns the full description of the program.
int	NumGroups () const
	Returns the number of groups found in the XML.
QString	GroupName (const int &group) const
	Returns the group name of group[index].
int	GroupIndex (const QString &grpName) const
	Given the group name get its index in group array.
int	NumParams (const int &) const
	Returns the number of parameters in a group.
QString	ParamName (const int &group, const int &param) const
	Returns the parameter name.
QString	ParamType (const int &group, const int &param) const
	Returns the parameter type of a parameter in a specified group.
QString	ParamBrief (const int &group, const int &param) const
	Returns the brief description of a parameter in a specified group.
QString	ParamDescription (const int &group, const int &param) const
	Returns the long description of a parameter in a specified group.
QString	ParamMinimum (const int &group, const int &param) const
	Returns the minimum value of a parameter in a specified group.
QString	ParamMinimumInclusive (const int &group, const int &param) const
	Returns whether the minimum value is inclusive or not.
QString	ParamMaximum (const int &group, const int &param) const
	Returns the maximum value of a parameter in a specified group.
QString	ParamMaximumInclusive (const int &group, const int &param) const
	Returns whether the maximum value is inclusive or not.
QString	ParamOdd (const int &group, const int &param) const
	Returns whether the selected parameter has a restriction on odd values or not.
int	ParamGreaterThanSize (const int &group, const int &param) const
	Returns the number of values in the parameters greater than list.
int	ParamGreaterThanOrEqualSize (const int &group, const int &param) const
	Returns the number of values in the parameters greater than or equal list.
int	ParamLessThanSize (const int &group, const int &param) const
	Returns the number of values in the parameters less than list.
int	ParamLessThanOrEqualSize (const int &group, const int &param) const
	Returns the number of values in the parameters less than or equal list.
int	ParamNotEqualSize (const int &group, const int &param) const
	Returns the number of values in the not equal list.
QString	ParamGreaterThan (const int &group, const int &param, const int &great) const
	Returns the name of the specified greaterThan parameter.
QString	ParamGreaterThanOrEqual (const int &group, const int &param, const int &great) const
	Returns the name of the specified greaterThanOrEqual parameter.
QString	ParamLessThan (const int &group, const int &param, const int &great) const
	Returns the name of the specified lessThan parameter.
QString	ParamLessThanOrEqual (const int &group, const int &param, const int &les) const
	Returns the name of the specified lessThanOrEqual parameter.
QString	ParamNotEqual (const int &group, const int &param, const int &notEq) const
	Returns the name of the specified notEqual parameter.
int	ParamListSize (const int &group, const int &param) const
	Returns the number of options in the specified parameter's list.
QString	ParamListValue (const int &group, const int &param, const int &option) const
	Returns the option value for a specific option to a parameter.
QString	ParamListBrief (const int &group, const int &param, const int &option) const
	Returns the brief description for a specific option to a parameter.
QString	ParamListDescription (const int &group, const int &param, const int &option) const
	Returns the full description for a specific option to a parameter.
int	ParamListExcludeSize (const int &group, const int &param, const int &option) const
	Returns the number of items in a parameters list exclude section.
QString	ParamListExclude (const int &group, const int &param, const int &option, const int &exclude) const
	Returns the parameter name to be excluded if this option is selected.
int	ParamListIncludeSize (const int &group, const int &param, const int &option) const
	Returns the number of items in a parameters list include section.
QString	ParamListInclude (const int &group, const int &param, const int &option, const int &include) const
	Returns the parameter name to be included if this option is selected.
QString	ParamDefault (const int &group, const int &param) const
	Returns the default for a parameter in a specified group.
QString	ParamInternalDefault (const int &group, const int &param) const
	Returns the internal default for a parameter in a specified group.
QString	ParamFilter (const int &group, const int &param) const
	Returns the parameter filter for a parameter in a specified group.
QString	ParamPath (const int &group, const int &param) const
	Returns the default path for a filename/cube parameter.
QString	ParamFileMode (const int &group, const int &param) const
	Returns the file mode for a parameter in a specified group.
int	ParamExcludeSize (const int &group, const int &param) const
	Returns the number of parameters excluded in this parameter's exclusions.
QString	ParamExclude (const int &group, const int &param, const int &exclude) const
	Returns the name of the specified excluded parameter.
int	ParamIncludeSize (const int &group, const int &param) const
	Returns the number of parameters included in this parameter's inclusions.
QString	ParamInclude (const int &group, const int &param, const int &include) const
	Returns the name of the specified included parameter.
QString	PixelType (const int &group, const int &param) const
	Returns the default pixel type from the XML.
int	HelpersSize (const int &group, const int &param) const
	Returns the number of helpers the parameter has.
QString	HelperButtonName (const int &group, const int &param, const int &helper) const
	Returns the name of the helper button.
QString	HelperFunction (const int &group, const int &param, const int &helper) const
	Returns the name of the helper function.
QString	HelperBrief (const int &group, const int &param, const int &helper) const
	Returns the brief description of the helper button.
QString	HelperDescription (const int &group, const int &param, const int &helper) const
	Returns the long description of the helper button.
QString	HelperIcon (const int &group, const int &param, const int &helper) const
	Returns the name of the icon for the helper button.
bool	IsParamInPvlInclude (QString &paramName, std::vector< QString > &exclude)
	Verify whether Parameter name is in the Include list Used in creation of DefFile.
void	CreatePVL (Isis::Pvl &pvlDef, QString guiGrpName, QString pvlObjName, QString pvlGrpName, std::vector< QString > &exclude)
	Create Pvl with the parameters in a user defined group given the Pvl object and group name.
void	VerifyAll ()
	Verify all parameters.
bool	StringToBool (QString value) const
	Returns a boolean value based on the QString contents.
void	CommandLine (Isis::Pvl &lab) const
	Creates a QString which could be used as a command line.
QString	Version () const
	Returns the application version date.
Protected Member Functions
const IsisParameterData *	ReturnParam (const QString &paramName) const
	Returns a pointer to a parameter whose name starts with paramName.
Protected Attributes
QString	name
QString	brief
QString	description
std::vector< IsisGroupData >	groups
std::vector< QString >	categorys
std::vector< IsisChangeData >	changes
Private Member Functions
void	LoadCommandLine (int argc, char *argv[])
	This is used to load the command line into p_cmdline and the Aml object using information contained in argc and argv.
void	LoadBatchList (const QString file)
	Loads the user entered batchlist file into a private variable for later use.
void	LoadHistory (const QString file)
	Loads the previous history for the program.
void	EvaluateOption (const QString name, const QString value)
	This interprets the "-" options for reserved parameters.
void	GetNextParameter (unsigned int &curPos, QString &name, std::vector< QString > &value)
	This gets the next parameter in the list of arguments.
std::vector< QString >	ReadArray (QString arrayString)
	This interprets an array value from the command line.
Private Attributes
std::vector< char * >	p_cmdline
	This variable will contain argv.
int	p_parentId
	This is a status to indicate if the GUI is running or not.
bool	p_abortOnError
	Boolean value representing whether to abort or continue on error.
QString	p_saveFile
	FileName to save last history to.
QString	p_progName
	Name of program to run.
QString	p_errList
	FileName to write batchlist line that caused error on.
std::vector< std::vector < QString > >	p_batchList
	Vector of batchlist data.
bool	p_interactive
	Boolean value representing whether the program is interactive or not.
bool	p_info
	Boolean value representing if its in debug mode.
QString	p_infoFileName
	FileName to save debugging info.
Gui *	p_gui
	Pointer to the gui object.

Detailed Description

Command Line and Xml loader, validation, and access.

This object is used to load and query user input via the command line. It requires as input to the constructor 1) an Isis Application Xml file and 2) the command line arguments (argc and argv). The Xml file will be used to validate the user input given on the command line (if any). To access user input see the Aml class which is inherited.

Author:: 2002-05-29 Jeff Anderson

For internal use only.

History:: 2002-10-25 Jeff Anderson - Command line mode was not fully verifying the AML object. Invoked the VerifyAll method after loading each of the command line tokens.

History:: 2003-02-07 Jeff Anderson - Modified constructor so that it will not start the GUI if the program name is unitTest.

History:: 2003-02-12 Jeff Anderson - Strip off leading directory in front of argv[0] so that unit tests run with pathnames do not start the Isis Gui.

History:: 2003-05-16 Stuart Sides - Modified schema from astrogeology... isis.astrogeology...

History:: 2003-12-16 Jeff Anderson - Added command line option -LAST and RESTORE=file.par

History:: 2004-02-26 Jeff Anderson - Added command line option -HELP

History:: 2004-02-26 Jeff Anderson - Modified to allow a parameter to appear multiple times on the command line

History:: 2004-02-29 Jeff Anderson - Added the -PID command line switch which allows interprocess communication to occur with the parent so that the parents GUI can be properly updated.

History:: 2005-02-22 Elizabeth Ribelin - Modified file to support Doxygen documentation

History:: 2005-10-03 Elizabeth Miller - changed

History:: 2005-12-21 Elizabeth Miller - Added command line options -BATCHLIST, -SAVE, -ERRLIST, -ONERROR, -PREFERENCE, and -PRINTFILE

History:: 2006-01-23 Elizabeth Miller - Renamed -HELP to -WEBHELP and made it accept abbreviations of reserve params

History:: 2007-07-12 Steven Koechle - Added -NOGUI flag

History:: 2007-10-04 Steven Koechle - Added -info flag. Debugging option to create a log of system info.

History:: 2008-02-22 Steven Koechle - Modified batchlist to take tab, command, and space characters as delimiters but also allow special cases like tab, as a single delimiter leaves quoted strings alone.

History:: 2008-04-16 Steven Lambright - Moved parameter verification call

History:: 2008-06-06 Steven Lambright - Changed corrupt history file message

History:: 2008-06-18 Steven Lambright - Fixed documentation

History:: 2008-09-23 Christopher Austin - Added a try/catch to SaveHistory(), where if the history file is corrupt, it simply overwrites it with the new single valid entry.

History:: 2008-01-07 Steven Lambright - Changed unit test and error on invalid parameter history files to conform with a FileName class change where expanded(...) always returns a full path.

History:: 2009-08-17 Steven Lambright - Parameters are now more correctly interpretted from argv resulting in fewer escape characters and problems such as " " (2 spaces) being interpretted properly. Array parameter values support improved.

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

History:: 2010-03-26 Sharmila Prasad - Remove the restriction of the number of columns in the batchlist file to 10.

History:: 2010-05-28 Steven Lambright - History fails silently now

History:: 2010-07-20 Steven Lambright - Array format on the command line is more tolerant to white space now.

History:: 2010-07-28 Steven Lambright - Fixed complicated escape sequence cases on array format parsing that have existed for a while now

History:: 2010-07-28 Christopher Austin - Fixed a -LAST issue causing IsisAml to throw an incorrect exception.

History:: 2010-10-28 Mackenzie Boyd - Modified error messages in LoadHistory()\

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

History:: 2011-08-31 Jai Rideout and Steven Lambright - Loading the history with -last no longer causes us to call PutAsString for parameters which match the defaults. This fixes an issue with the new spiceinit GUI with "WEB" added... -last would always throw an error.

History:: 2011-09-21 Steven Lambright - When the -batchlist does not understand a variable it would crash. This prevented users from entering variables like $base, $mro, etc. Now when -batchlist does not understand a variable it preserves it in the parameter list. Fixes #365.

Definition at line 130 of file UserInterface.h.

Constructor & Destructor Documentation

Isis::UserInterface::UserInterface	(	const QString &	xmlfile,
		int &	argc,
		char *	argv[]
	)

Constructs an UserInterface object.

Parameters:

	xmlfile	Name of the Isis application xml file to open.
	argc	Number of arguments on the command line. Must be pass by reference!!
	argv[]	Array of arguments

Definition at line 52 of file UserInterface.cpp.

References Isis::Gui::checkX11(), LoadCommandLine(), p_abortOnError, p_errList, p_gui, p_info, p_infoFileName, p_interactive, p_parentId, and p_saveFile.

Isis::UserInterface::~UserInterface ( )

Destroys the UserInterface object.

Definition at line 85 of file UserInterface.cpp.

References p_gui.

Member Function Documentation

bool Isis::UserInterface::AbortOnError ( ) [inline]

Returns true if the program should abort on error, and false if it should continue.

Returns:: bool True for abort, False for continue

Definition at line 177 of file UserInterface.h.

References p_abortOnError.

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

int Isis::UserInterface::BatchListSize ( ) [inline]

Returns the size of the batchlist.

If there is no batchlist, it will return 0

Returns:: int The size of the batchlist

Definition at line 158 of file UserInterface.h.

References p_batchList.

Referenced by LoadCommandLine(), and Isis::Application::Run().

QString IsisAml::Brief ( ) const [inherited]

Returns the brief description of the program.

Returns:: The brief description.

Definition at line 1084 of file IsisAml.cpp.

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

void IsisAml::Clear ( const QString & paramName ) [inherited]

Clears the value(s) in the named parameter.

Parameters:

paramName

The name of the parameter to clear

Definition at line 1868 of file IsisAml.cpp.

References IsisAml::ReturnParam(), and Isis::CubeAttribute< ChildClass >::setAttributes().

Referenced by Isis::Gui::InvokeHelper(), LoadCommandLine(), Isis::Gui::ResetParameters(), SetBatchList(), Isis::ProcessExport::SetInputRange(), Isis::Gui::StartProcess(), and Isis::Gui::UpdateHistory().

void IsisAml::CommandLine ( Isis::Pvl & cont ) const [inherited]

Creates a QString which could be used as a command line.

Parameters:

cont

Pvl to put command line information in

Definition at line 2926 of file IsisAml.cpp.

References Isis::PvlObject::AddGroup(), Isis::PvlKeyword::AddValue(), Isis::PvlObject::Clear(), Isis::PvlContainer::DeleteKeyword(), g, IsisAml::GetAsString(), Isis::PvlContainer::HasKeyword(), IsisAml::ParamName(), IsisAml::ReturnParam(), Isis::IString::Trim(), and Isis::IString::UpCase().

Referenced by Isis::Application::History(), and SaveHistory().

void IsisAml::CreatePVL	(	Isis::Pvl &	pvlDef,
		QString	guiGrpName,
		QString	pvlObjName,
		QString	pvlGrpName,
		std::vector< QString > &	exclude
	)			`[inherited]`

Create Pvl with the parameters in a user defined group given the Pvl object and group name.

QString IsisAml::Description ( ) const [inherited]

Returns the full description of the program.

Returns:: The full description.

Definition at line 1094 of file IsisAml.cpp.

void Isis::UserInterface::EvaluateOption	(	const QString	name,
		const QString	value
	)			`[private]`

This interprets the "-" options for reserved parameters.

Parameters:

	name	"-OPTIONNAME"
	value	Value of the option, if supplied (-name=value)

Definition at line 467 of file UserInterface.cpp.

References _FILEINFO_, Isis::PvlObject::AddGroup(), Isis::PvlKeyword::AddValue(), exit(), Isis::PvlObject::FindGroup(), LoadBatchList(), LoadHistory(), IsisAml::NumGroups(), IsisAml::NumParams(), p_abortOnError, p_errList, p_info, p_infoFileName, p_interactive, p_parentId, p_progName, p_saveFile, IsisAml::ParamBrief(), IsisAml::ParamDefault(), IsisAml::ParamExclude(), IsisAml::ParamExcludeSize(), IsisAml::ParamGreaterThan(), IsisAml::ParamGreaterThanOrEqual(), IsisAml::ParamGreaterThanOrEqualSize(), IsisAml::ParamGreaterThanSize(), IsisAml::ParamInclude(), IsisAml::ParamIncludeSize(), IsisAml::ParamInternalDefault(), IsisAml::ParamLessThan(), IsisAml::ParamLessThanOrEqual(), IsisAml::ParamLessThanOrEqualSize(), IsisAml::ParamLessThanSize(), IsisAml::ParamListBrief(), IsisAml::ParamListExclude(), IsisAml::ParamListExcludeSize(), IsisAml::ParamListInclude(), IsisAml::ParamListIncludeSize(), IsisAml::ParamListSize(), IsisAml::ParamListValue(), IsisAml::ParamMaximum(), IsisAml::ParamMaximumInclusive(), IsisAml::ParamMinimum(), IsisAml::ParamMinimumInclusive(), IsisAml::ParamName(), IsisAml::ParamNotEqual(), IsisAml::ParamNotEqualSize(), IsisAml::ParamOdd(), IsisAml::ParamType(), IsisAml::PixelType(), IsisAml::ProgramName(), Isis::ProgramLauncher::RunSystemCommand(), Isis::Pvl::SetTerminator(), Isis::toInt(), Isis::PvlObject::Traverse, Isis::IException::Unknown, and Isis::IException::User.

Referenced by LoadCommandLine().

QString IsisAml::GetAsString ( const QString & paramName ) const [inherited]

Allows the retrieval of a value for a parameter of any type.

The value will be returned as a QString no matter what the parameter type is.

Parameters:

paramName

The partial or full name of the parameter to be retrieved.

Returns:: A QString representation of the value for the specified parameter.

Exceptions:

iException

(IsisProgrammerError) The parameter has no value.

Definition at line 553 of file IsisAml.cpp.

References _FILEINFO_, Isis::IException::Programmer, and IsisAml::ReturnParam().

Referenced by Isis::PipelineApplication::AddParameter(), IsisAml::CommandLine(), Isis::Pipeline::SetInputFile(), Isis::Pipeline::SetOutputFile(), Isis::GuiParameter::SetToCurrent(), Isis::GuiParameter::Update(), and IsisAml::VerifyAll().

bool IsisAml::GetBoolean ( const QString & paramName ) const [inherited]

Allows the retrieval of a value for a parameter of type "boolean".

Parameters:

paramName

The partial or full name of the parameter to be retrieved.

Returns:: The value of the parameter.

Exceptions:

iException::Programmer

(IsisErrorUser) The parameter has no value.

Definition at line 989 of file IsisAml.cpp.

References _FILEINFO_, Isis::IException::Programmer, IsisAml::ReturnParam(), Isis::toBool(), and Isis::IException::User.

double IsisAml::GetDouble ( const QString & paramName ) const [inherited]

Allows the retrieval of a value for a parameter of type "double".

Parameters:

paramName

The partial or full name of the parameter to be retrieved.

Returns:: The value of the parameter.

Exceptions:

iException::Programmer

(IsisErrorUser) The parameter has no value.

Definition at line 907 of file IsisAml.cpp.

References _FILEINFO_, Isis::IException::Programmer, IsisAml::ReturnParam(), Isis::IString::ToDouble(), and Isis::IException::User.

Referenced by Isis::ProcessByQuickFilter::GetFilterParameters(), Isis::ProcessExport::SetInputRange(), and IsisAml::VerifyAll().

QString IsisAml::GetFileName	(	const QString &	paramName,
		QString	extension = `""`
	)			const `[inherited]`

Allows the retrieval of a value for a parameter of type "filename".

Parameters:

	paramName	The partial or full name of the parameter to be retrieved.
	extension	A default extension to add if it does not already exist on the file name. For example, "txt" will make /mydir/myfile into /mydir/myfile.txt

Returns:: The value of the parameter.

Definition at line 623 of file IsisAml.cpp.

References _FILEINFO_, Isis::IException::Programmer, IsisAml::ReturnParam(), and Isis::IException::User.

Referenced by Isis::Process::SetInputCube(), Isis::Pipeline::SetInputFile(), Isis::Pipeline::SetInputListFile(), Isis::ProcessPolygons::SetOutputCube(), Isis::ProcessMosaic::SetOutputCube(), Isis::ProcessGroundPolygons::SetOutputCube(), Isis::Process::SetOutputCube(), and Isis::Pipeline::SetOutputListFile().

QString Isis::UserInterface::GetInfoFileName ( )

This method returns the filename where the debugging info is stored when the "-info" tag is used.

Returns:: QString Name of file containing debugging ingo.

Definition at line 1061 of file UserInterface.cpp.

References p_infoFileName.

Referenced by Isis::Application::FunctionCleanup(), and Isis::Application::FunctionError().

bool Isis::UserInterface::GetInfoFlag ( )

This method returns the flag state of info.

This returns if its in debugging mode(the -info tag was specified).

Returns:: bool Flag state on info.

Definition at line 1051 of file UserInterface.cpp.

References p_info.

Referenced by Isis::Application::FunctionCleanup(), and Isis::Application::FunctionError().

Isis::CubeAttributeInput & IsisAml::GetInputAttribute ( const QString & paramName ) [inherited]

Gets the attributes for an input cube.

Parameters:

paramName

The name of the parameter to get the attributes for

Returns:: CubeAttributeInput

Exceptions:

	iException::Programmer	"Parameter is not a cube."
	iException::Programmer	"Parameter in not an input cube"

Definition at line 1890 of file IsisAml.cpp.

References _FILEINFO_, Isis::IException::Programmer, IsisAml::ReturnParam(), and Isis::CubeAttribute< ChildClass >::setAttributes().

Referenced by Isis::Process::SetInputCube(), and Isis::Pipeline::SetInputFile().

int IsisAml::GetInteger ( const QString & paramName ) const [inherited]

Allows the retrieval of a value for a parameter of type "integer".

Parameters:

paramName

The partial or full name of the parameter to be retrieved.

Returns:: The value of the parameter.

Exceptions:

iException::Programmer

(IsisErrorUser) The parameter has no value.

Definition at line 823 of file IsisAml.cpp.

References _FILEINFO_, Isis::IException::Programmer, IsisAml::ReturnParam(), Isis::IString::ToInteger(), and Isis::IException::User.

Referenced by Isis::ProcessByQuickFilter::GetFilterParameters(), and IsisAml::VerifyAll().

void Isis::UserInterface::GetNextParameter	(	unsigned int &	curPos,
		QString &	name,
		std::vector< QString > &	value
	)			`[private]`

This gets the next parameter in the list of arguments.

curPos will be changed to be the end of the current argument (still needs incremented to get the next argument).

Parameters:

	curPos	End of previous argument
	name	Resulting parameter name
	value	Resulting array of parameter values (usually just 1 element)

Definition at line 267 of file UserInterface.cpp.

References _FILEINFO_, p_cmdline, ReadArray(), and Isis::IException::User.

Referenced by LoadCommandLine(), and SetBatchList().

Isis::CubeAttributeOutput & IsisAml::GetOutputAttribute ( const QString & paramName ) [inherited]

Gets the attributes for an output cube.

Parameters:

paramName

The name of the parameter to get the attributes for

Returns:: CubeAttributeOutput

Exceptions:

	iException::Programmer	"Parameter is not a cube"
	iException::Programmer	"Parameter in not an output"

Definition at line 1935 of file IsisAml.cpp.

References _FILEINFO_, Isis::CubeAttribute< ChildClass >::addAttributes(), Isis::IException::Programmer, IsisAml::ReturnParam(), and Isis::CubeAttribute< ChildClass >::setAttributes().

Referenced by Isis::ProcessPolygons::SetOutputCube(), Isis::ProcessImport::SetOutputCube(), Isis::ProcessGroundPolygons::SetOutputCube(), and Isis::Process::SetOutputCube().

QString IsisAml::GetString ( const QString & paramName ) const [inherited]

Allows the retrieval of a value for a parameter of type "string".

Parameters:

paramName

The partial or full name of the parameter to be retrieved.

Returns:: The value of the parameter.

Exceptions:

iException::Programmer

(IsisErrorUser) The parameter has no value.

Definition at line 708 of file IsisAml.cpp.

References _FILEINFO_, Isis::IException::Programmer, IsisAml::ReturnParam(), and Isis::IException::User.

Referenced by Isis::ProcessExport::SetInputRange(), and IsisAml::VerifyAll().

int IsisAml::GroupIndex ( const QString & grpName ) const [inherited]

Given the group name get its index in group array.

Given group name return its index in the Gui.

Author:: Sharmila Prasad (8/11/2011)

Parameters:

grpName

Returns:: int

Definition at line 1128 of file IsisAml.cpp.

QString IsisAml::GroupName ( const int & index ) const [inherited]

Returns the group name of group[index].

Parameters:

index

The array index of the group.

Returns:: The group name.

Definition at line 1114 of file IsisAml.cpp.

QString IsisAml::HelperBrief	(	const int &	group,
		const int &	param,
		const int &	helper
	)			const `[inherited]`

Returns the brief description of the helper button.

Parameters:

	group	The group index
	param	The parameter index
	helper	The helper index

Returns:: QString The brief description of the helper button

Definition at line 1812 of file IsisAml.cpp.

Referenced by Isis::GuiParameter::AddHelpers().

QString IsisAml::HelperButtonName	(	const int &	group,
		const int &	param,
		const int &	helper
	)			const `[inherited]`

Returns the name of the helper button.

Parameters:

	group	The group index
	param	The parameter index
	helper	The helper index

Returns:: QString The name of the helper

Definition at line 1784 of file IsisAml.cpp.

Referenced by Isis::GuiParameter::AddHelpers().

QString IsisAml::HelperDescription	(	const int &	group,
		const int &	param,
		const int &	helper
	)			const `[inherited]`

Returns the long description of the helper button.

Parameters:

	group	The group index
	param	The parameter index
	helper	The helper index

Returns:: QString The long description of the helper button

Definition at line 1826 of file IsisAml.cpp.

Referenced by Isis::GuiParameter::AddHelpers().

QString IsisAml::HelperFunction	(	const int &	group,
		const int &	param,
		const int &	helper
	)			const `[inherited]`

Returns the name of the helper function.

Parameters:

	group	The group index
	param	The parameter index
	helper	The helper index

Returns:: QString The name of the helper function

Definition at line 1798 of file IsisAml.cpp.

Referenced by Isis::GuiParameter::AddHelpers().

QString IsisAml::HelperIcon	(	const int &	group,
		const int &	param,
		const int &	helper
	)			const `[inherited]`

Returns the name of the icon for the helper button.

Parameters:

	group	The group index
	param	The parameter index
	helper	The helper index

Returns:: QString The name of the helper icon

Definition at line 1840 of file IsisAml.cpp.

Referenced by Isis::GuiParameter::AddHelpers().

int IsisAml::HelpersSize	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns the number of helpers the parameter has.

Parameters:

	group	The group index
	param	The parameter index

Returns:: int The number of helpers the parameter has

Definition at line 1771 of file IsisAml.cpp.

Referenced by Isis::GuiParameter::AddHelpers(), and Isis::GuiFileNameParameter::GuiFileNameParameter().

bool Isis::UserInterface::IsInteractive ( ) [inline]

Indicates if the Isis Graphical User Interface is operating.

Returns:: bool

Definition at line 140 of file UserInterface.h.

References p_gui.

Referenced by Isis::Application::Application(), Isis::Application::FunctionCleanup(), Isis::Application::FunctionError(), Isis::Application::GuiLog(), Isis::Application::History(), Isis::Application::Log(), Isis::Application::ProcessGuiEvents(), Isis::Application::Run(), and Isis::Application::UpdateProgress().

bool IsisAml::IsParamInPvlInclude	(	QString &	paramName,
		std::vector< QString > &	exclude
	)			`[inherited]`

Verify whether Parameter name is in the Include list Used in creation of DefFile.

void Isis::UserInterface::LoadBatchList ( const QString file ) [private]

Loads the user entered batchlist file into a private variable for later use.

Parameters:

file

The batchlist file to load

History:: 2010-03-26 Sharmila Prasad - Remove the restriction of the number of columns in the batchlist file to 10.

Exceptions:

Isis::IException::User

- The batchlist does not contain any data

Definition at line 736 of file UserInterface.cpp.

References _FILEINFO_, Isis::TextFile::GetLine(), Isis::TextFile::LineCount(), Isis::TextFile::Open(), p_batchList, size, and Isis::IException::User.

Referenced by EvaluateOption().

void Isis::UserInterface::LoadCommandLine	(	int	argc,
		char *	argv[]
	)			`[private]`

This is used to load the command line into p_cmdline and the Aml object using information contained in argc and argv.

Parameters:

	argc	Number of arguments on the command line
	argv[]	Array of arguments

Exceptions:

	Isis::IException::User	- Invalid command line
	Isis::IException::System	- -GUI and -PID are incompatible arguments
	Isis::IException::System	- -BATCHLIST & -GUI are incompatible arguments

Definition at line 105 of file UserInterface.cpp.

References _FILEINFO_, BatchListSize(), IsisAml::Clear(), compare(), EvaluateOption(), GetNextParameter(), p_abortOnError, p_cmdline, p_errList, p_interactive, p_progName, p_saveFile, IsisAml::PutAsString(), and Isis::IException::User.

Referenced by UserInterface().

void Isis::UserInterface::LoadHistory ( const QString file ) [private]

Loads the previous history for the program.

Parameters:

file

FileName to get the history entry from

Exceptions:

	Isis::iException::User	- The file does not contain any parameters to restore
	Isis::iException::User	- The file does not contain a valid parameter history file
	Isis::iException::User	- Parameter history file does not exist

Definition at line 803 of file UserInterface.cpp.

References _FILEINFO_, g, Isis::PvlObject::Group(), Isis::PvlObject::Groups(), Isis::PvlContainer::IsNamed(), Isis::PvlContainer::Keywords(), Isis::PvlContainer::Name(), IsisAml::ProgramName(), IsisAml::PutAsString(), IsisAml::ReturnParam(), and Isis::IException::User.

Referenced by EvaluateOption().

int IsisAml::NumGroups ( ) const [inherited]

Returns the number of groups found in the XML.

Returns:: The number of groups.

Definition at line 1103 of file IsisAml.cpp.

Referenced by EvaluateOption(), Isis::Gui::Gui(), and SetBatchList().

int IsisAml::NumParams ( const int & group ) const [inherited]

Returns the number of parameters in a group.

Parameters:

group

The group to measure.

Returns:: The number of parameters.

Definition at line 1223 of file IsisAml.cpp.

Referenced by EvaluateOption(), Isis::Gui::Gui(), and SetBatchList().

QString IsisAml::ParamBrief	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns the brief description of a parameter in a specified group.

Parameters:

	group	The group index
	param	The parameter index

Returns:: The brief description.

Definition at line 1248 of file IsisAml.cpp.

Referenced by EvaluateOption(), and Isis::GuiParameter::GuiParameter().

QString IsisAml::ParamDefault	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns the default for a parameter in a specified group.

Parameters:

	group	The group index
	param	The parameter index

Returns:: The default for the specified parameter.

Definition at line 1521 of file IsisAml.cpp.

Referenced by EvaluateOption(), Isis::GuiParameter::GuiParameter(), Isis::GuiParameter::IsModified(), Isis::GuiBooleanParameter::IsModified(), Isis::GuiParameter::SetToDefault(), and Isis::GuiParameter::Update().

QString IsisAml::ParamDescription	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns the long description of a parameter in a specified group.

Parameters:

	group	The group index
	param	The parameter index

Returns:: The long description

Definition at line 1261 of file IsisAml.cpp.

QString IsisAml::ParamExclude	(	const int &	group,
		const int &	param,
		const int &	exclude
	)			const `[inherited]`

Returns the name of the specified excluded parameter.

Parameters:

	group	The group index
	param	The parameter index
	exclude	The exclude index

Returns:: The name of the excluded parameter

Definition at line 1478 of file IsisAml.cpp.

Referenced by EvaluateOption(), Isis::GuiBooleanParameter::Exclusions(), and Isis::GuiParameter::GuiParameter().

int IsisAml::ParamExcludeSize	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns the number of parameters excluded in this parameter's exclusions.

Parameters:

	group	The group index
	param	The parameter index

Returns:: The number of items in the parameters exclude list

Definition at line 1735 of file IsisAml.cpp.

Referenced by EvaluateOption(), Isis::GuiBooleanParameter::Exclusions(), and Isis::GuiParameter::GuiParameter().

QString IsisAml::ParamFileMode	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns the file mode for a parameter in a specified group.

Parameters:

	group	The group index
	param	The parameter index

Returns:: The file mode for the parameter.

Definition at line 1597 of file IsisAml.cpp.

Referenced by Isis::GuiCubeParameter::SelectAttribute(), and Isis::GuiFileNameParameter::SelectFile().

QString IsisAml::ParamFilter	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns the parameter filter for a parameter in a specified group.

Parameters:

	group	The group index
	param	The parameter index

Returns:: The paramter filter.

Definition at line 1559 of file IsisAml.cpp.

References filter().

Referenced by Isis::GuiFileNameParameter::SelectFile().

QString IsisAml::ParamGreaterThan	(	const int &	group,
		const int &	param,
		const int &	great
	)			const `[inherited]`

Returns the name of the specified greaterThan parameter.

Parameters:

	group	The group index
	param	The parameter index
	great	The greaterThan index

Returns:: The name of the greaterThan parameter

Definition at line 1403 of file IsisAml.cpp.

Referenced by EvaluateOption(), and Isis::GuiParameter::GuiParameter().

QString IsisAml::ParamGreaterThanOrEqual	(	const int &	group,
		const int &	param,
		const int &	great
	)			const `[inherited]`

Returns the name of the specified greaterThanOrEqual parameter.

Parameters:

	group	The group index
	param	The parameter index
	great	The greaterThanOrEqual index

Returns:: The name of the greaterThanOrEqual parameter

Definition at line 1418 of file IsisAml.cpp.

Referenced by EvaluateOption(), and Isis::GuiParameter::GuiParameter().

int IsisAml::ParamGreaterThanOrEqualSize	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns the number of values in the parameters greater than or equal list.

Parameters:

	group	The group index
	param	The parameter index

Returns:: Number of values in the parameters greater than or equal list

Definition at line 1352 of file IsisAml.cpp.

Referenced by EvaluateOption(), and Isis::GuiParameter::GuiParameter().

int IsisAml::ParamGreaterThanSize	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns the number of values in the parameters greater than list.

Parameters:

	group	The group index
	param	The parameter index

Returns:: Number of values in the parameters greater than list

Definition at line 1340 of file IsisAml.cpp.

Referenced by EvaluateOption(), and Isis::GuiParameter::GuiParameter().

QString IsisAml::ParamInclude	(	const int &	group,
		const int &	param,
		const int &	include
	)			const `[inherited]`

Returns the name of the specified included parameter.

Parameters:

	group	The group index
	param	The parameter index
	include	The include index

Returns:: The name of the included parameter

Definition at line 1493 of file IsisAml.cpp.

Referenced by EvaluateOption(), Isis::GuiBooleanParameter::Exclusions(), and Isis::GuiParameter::GuiParameter().

int IsisAml::ParamIncludeSize	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns the number of parameters included in this parameter's inclusions.

Parameters:

	group	The group index
	param	The parameter index

Returns:: The number of items in the parameters include list

Definition at line 1747 of file IsisAml.cpp.

Referenced by EvaluateOption(), Isis::GuiBooleanParameter::Exclusions(), and Isis::GuiParameter::GuiParameter().

QString IsisAml::ParamInternalDefault	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns the internal default for a parameter in a specified group.

.

Parameters:

	group	The group index
	param	The parameter index

Returns:: The internal default for the specified parameter.

Definition at line 1540 of file IsisAml.cpp.

Referenced by EvaluateOption(), Isis::GuiParameter::GuiParameter(), Isis::GuiParameter::IsModified(), Isis::GuiFileNameParameter::SelectFile(), Isis::GuiParameter::SetToDefault(), and Isis::GuiParameter::Update().

QString IsisAml::ParamLessThan	(	const int &	group,
		const int &	param,
		const int &	les
	)			const `[inherited]`

Returns the name of the specified lessThan parameter.

Parameters:

	group	The group index
	param	The parameter index
	les	The lessThan index

Returns:: The name of the lessThan parameter

Definition at line 1433 of file IsisAml.cpp.

Referenced by EvaluateOption(), and Isis::GuiParameter::GuiParameter().

QString IsisAml::ParamLessThanOrEqual	(	const int &	group,
		const int &	param,
		const int &	les
	)			const `[inherited]`

Returns the name of the specified lessThanOrEqual parameter.

Parameters:

	group	The group index
	param	The parameter index
	les	The lessThanOrEqual index

Returns:: The name of the lessThanOrEqual parameter

Definition at line 1448 of file IsisAml.cpp.

Referenced by EvaluateOption(), and Isis::GuiParameter::GuiParameter().

int IsisAml::ParamLessThanOrEqualSize	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns the number of values in the parameters less than or equal list.

Parameters:

	group	The group index
	param	The parameter index

Returns:: Number of values in the parameters less than or equal list

Definition at line 1377 of file IsisAml.cpp.

Referenced by EvaluateOption(), and Isis::GuiParameter::GuiParameter().

int IsisAml::ParamLessThanSize	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns the number of values in the parameters less than list.

Parameters:

	group	The group index
	param	The parameter index

Returns:: Number of values in the parameters less than list

Definition at line 1365 of file IsisAml.cpp.

Referenced by EvaluateOption(), and Isis::GuiParameter::GuiParameter().

QString IsisAml::ParamListBrief	(	const int &	group,
		const int &	param,
		const int &	option
	)			const `[inherited]`

Returns the brief description for a specific option to a parameter.

Parameters:

	group	The group index
	param	The parameter index
	option	The option number within the parameters list.

Returns:: The brief description of the option.

Definition at line 1646 of file IsisAml.cpp.

Referenced by EvaluateOption().

QString IsisAml::ParamListDescription	(	const int &	group,
		const int &	param,
		const int &	option
	)			const `[inherited]`

Returns the full description for a specific option to a parameter.

Parameters:

	group	The group index
	param	The parameter index
	option	The option number within the parameters list.

Returns:: The full description of the option.

Definition at line 1661 of file IsisAml.cpp.

QString IsisAml::ParamListExclude	(	const int &	group,
		const int &	param,
		const int &	option,
		const int &	exclude
	)			const `[inherited]`

Returns the parameter name to be excluded if this option is selected.

Parameters:

	group	The group index
	param	The parameter index
	option	The option number within the parameters list.
	exclude	The exclusion number within the parameters list.

Returns:: The parameter name to be excluded if this option is selected.

Definition at line 1691 of file IsisAml.cpp.

Referenced by EvaluateOption(), Isis::GuiListParameter::Exclusions(), and Isis::GuiComboBoxParameter::Exclusions().

int IsisAml::ParamListExcludeSize	(	const int &	group,
		const int &	param,
		const int &	option
	)			const `[inherited]`

Returns the number of items in a parameters list exclude section.

Parameters:

	group	The group index
	param	The parameter index
	option	The option number within the parameters list.

Returns:: The number of items in the parameters list exclude section.

Definition at line 1676 of file IsisAml.cpp.

Referenced by EvaluateOption(), Isis::GuiListParameter::Exclusions(), and Isis::GuiComboBoxParameter::Exclusions().

QString IsisAml::ParamListInclude	(	const int &	group,
		const int &	param,
		const int &	option,
		const int &	include
	)			const `[inherited]`

Returns the parameter name to be included if this option is selected.

Parameters:

	group	The group index
	param	The parameter index
	option	The option number within the parameters list.
	include	The inclusion number within the parameters list.

Returns:: The parameter name to be included if this option is selected.

Definition at line 1721 of file IsisAml.cpp.

Referenced by EvaluateOption().

int IsisAml::ParamListIncludeSize	(	const int &	group,
		const int &	param,
		const int &	option
	)			const `[inherited]`

Returns the number of items in a parameters list include section.

Parameters:

	group	The group index
	param	The parameter index
	option	The option number within the parameters list.

Returns:: The number of items in the parameters list include section.

Definition at line 1706 of file IsisAml.cpp.

Referenced by EvaluateOption().

int IsisAml::ParamListSize	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns the number of options in the specified parameter's list.

Parameters:

	group	The group index
	param	The parameter index

Returns:: The number of options contained in the parameter's list. If the parameter does not contain a list, zero will be returned.

Definition at line 1617 of file IsisAml.cpp.

Referenced by EvaluateOption().

QString IsisAml::ParamListValue	(	const int &	group,
		const int &	param,
		const int &	option
	)			const `[inherited]`

Returns the option value for a specific option to a parameter.

Parameters:

	group	The group index
	param	The parameter index
	option	The option number within the parameters list.

Returns:: The value of the option.

Definition at line 1631 of file IsisAml.cpp.

Referenced by EvaluateOption().

QString IsisAml::ParamMaximum	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns the maximum value of a parameter in a specified group.

Parameters:

	group	The group index
	param	The parameter index

Returns:: The maximum

Definition at line 1287 of file IsisAml.cpp.

Referenced by EvaluateOption(), and Isis::GuiParameter::GuiParameter().

QString IsisAml::ParamMaximumInclusive	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns whether the maximum value is inclusive or not.

Parameters:

	group	The group index
	param	The parameter index

Returns:: Whether maximum is inclusive or not

Definition at line 1313 of file IsisAml.cpp.

Referenced by EvaluateOption(), and Isis::GuiParameter::GuiParameter().

QString IsisAml::ParamMinimum	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns the minimum value of a parameter in a specified group.

Parameters:

	group	The group index
	param	The parameter index

Returns:: The minimum

Definition at line 1274 of file IsisAml.cpp.

Referenced by EvaluateOption(), and Isis::GuiParameter::GuiParameter().

QString IsisAml::ParamMinimumInclusive	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns whether the minimum value is inclusive or not.

Parameters:

	group	The group index
	param	The parameter index

Returns:: Whether minimum is inclusive or not

Definition at line 1300 of file IsisAml.cpp.

Referenced by EvaluateOption(), and Isis::GuiParameter::GuiParameter().

QString IsisAml::ParamName	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns the parameter name.

Parameters:

	group	The group index where the parameter can be found.
	param	The index of the parameter to name.

Returns:: The name of the parameter.

Definition at line 1235 of file IsisAml.cpp.

Referenced by IsisAml::CommandLine(), EvaluateOption(), Isis::GuiParameter::GuiParameter(), Isis::GuiCubeParameter::SelectAttribute(), and SetBatchList().

QString IsisAml::ParamNotEqual	(	const int &	group,
		const int &	param,
		const int &	notEq
	)			const `[inherited]`

Returns the name of the specified notEqual parameter.

Parameters:

	group	The group index
	param	The parameter index
	notEq	The notEqual index

Returns:: The name of the notEqual parameter

Definition at line 1463 of file IsisAml.cpp.

Referenced by EvaluateOption(), and Isis::GuiParameter::GuiParameter().

int IsisAml::ParamNotEqualSize	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns the number of values in the not equal list.

Parameters:

	group	The group index
	param	The parameter index

Returns:: Number of values in the parameters not equal list

Definition at line 1390 of file IsisAml.cpp.

Referenced by EvaluateOption(), and Isis::GuiParameter::GuiParameter().

QString IsisAml::ParamOdd	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns whether the selected parameter has a restriction on odd values or not.

Parameters:

	group	The group index
	param	The parameter index

Returns:: Whether the parameter restricts odd values or not

Definition at line 1327 of file IsisAml.cpp.

Referenced by EvaluateOption(), and Isis::GuiParameter::GuiParameter().

QString IsisAml::ParamPath	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns the default path for a filename/cube parameter.

Parameters:

	group	The group index
	param	The parameter index

Returns:: The default path.

Definition at line 1578 of file IsisAml.cpp.

Referenced by Isis::GuiFileNameParameter::SelectFile().

QString IsisAml::ParamType	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns the parameter type of a parameter in a specified group.

Parameters:

	group	The group index
	param	The parameter index

Returns:: The type of parameter.

Definition at line 1508 of file IsisAml.cpp.

Referenced by EvaluateOption(), and Isis::GuiParameter::GuiParameter().

int Isis::UserInterface::ParentId ( ) [inline]

Returns the parent id.

Returns:: int The parent id

Definition at line 167 of file UserInterface.h.

References p_parentId.

Referenced by Isis::Application::Application(), Isis::Application::HasParent(), and Isis::Application::SendParentData().

QString IsisAml::PixelType	(	const int &	group,
		const int &	param
	)			const `[inherited]`

Returns the default pixel type from the XML.

Parameters:

	group	The group index
	param	The parameter index

Returns:: The default pixel type

Definition at line 1759 of file IsisAml.cpp.

Referenced by EvaluateOption(), Isis::GuiParameter::GuiParameter(), and Isis::GuiCubeParameter::SelectAttribute().

QString IsisAml::ProgramName ( ) const [inherited]

Returns the Program name.

Returns:: The name of the program.

Definition at line 1073 of file IsisAml.cpp.

Referenced by EvaluateOption(), Isis::Application::History(), LoadHistory(), SaveHistory(), Isis::Gui::ShowWarning(), Isis::Gui::StopProcessing(), Isis::Gui::UpdateCommandLine(), Isis::Gui::UpdateHistory(), and Isis::Application::UpdateProgress().

void IsisAml::PutAsString	(	const QString &	paramName,
		const QString &	value
	)			`[inherited]`

Allows the insertion of a value for any parameter.

No validity check is performed on the value passed in.

Parameters:

	paramName	The partial or full name of the parameter to be modified.
	value	The QString representation of the value to be placed in the parameters value data member. For parameters of type integer, the QString must be convertable to an integer. For parameters of type double, the QString must be convertable to a double. For parameters of type boolean, the QString must be one of: (TRUE, FALSE, YES, NO, or a partial match of any of these beginning with the first character).

Exceptions:

IException

The parameter already has a value in its "value" data member.Overwriting an existing value is not allowed. Use "Clear" to erase all values in the value data member instead of overwriting an existing value.

Definition at line 81 of file IsisAml.cpp.

References _FILEINFO_, IsisAml::ReturnParam(), and Isis::IException::User.

Referenced by Isis::Gui::InvokeHelper(), LoadCommandLine(), LoadHistory(), SetBatchList(), Isis::Gui::StartProcess(), and Isis::Gui::UpdateHistory().

void IsisAml::PutBoolean	(	const QString &	paramName,
		const bool &	value
	)			`[inherited]`

Allows the insertion of a value for a parameter of type "boolean".

A validity check is performed on the value passed in.

Parameters:

	paramName	The partial or full name of the parameter to be modified.
	value	The boolean value to be placed in the boolean's value data member.

Exceptions:

	iException	(IsisProgrammerError) The parameter already has a value in its "value" data member.Overwriting an existing value is not allowed. Use "Clear" to erase all values in the value data member instead of overwriting an existing value.
	iException	(IsisProgrammerError) The parameter is not of type "boolean".

Definition at line 462 of file IsisAml.cpp.

References _FILEINFO_, Isis::IException::Programmer, IsisAml::ReturnParam(), and IsisAml::Verify().

void IsisAml::PutDouble	(	const QString &	paramName,
		const double &	value
	)			`[inherited]`

Allows the insertion of a value for a parameter of type "double".

A validity check is performed on the value passed in.

Parameters:

	paramName	The partial or full name of the parameter to be modified.
	value	The double value to be placed in the double's value data member.

Exceptions:

	iException	(IsisProgrammerError) The parameter already has a value in its "value" data member.Overwriting an existing value is not allowed. Use "Clear" to erase all values in the value data member instead of overwriting an existing value.
	iException	(IsisProgrammerError) The parameter is not of type "double".

Definition at line 377 of file IsisAml.cpp.

References _FILEINFO_, Isis::IException::Programmer, IsisAml::ReturnParam(), Isis::toString(), and IsisAml::Verify().

Referenced by Isis::ProcessExport::SetInputRange().

void IsisAml::PutFileName	(	const QString &	paramName,
		const QString &	value
	)			`[inherited]`

Allows the insertion of a value for a parameter of type "filename".

A validity check is performed on the value passed in.

Parameters:

	paramName	The partial or full name of the parameter to be modified.
	value	The QString representation of the value to be placed in the filename's value data member.

Definition at line 211 of file IsisAml.cpp.

References _FILEINFO_, Isis::IException::Programmer, IsisAml::ReturnParam(), and IsisAml::Verify().

void IsisAml::PutInteger	(	const QString &	paramName,
		const int &	value
	)			`[inherited]`

Allows the insertion of a value for a parameter of type "integer".

A validity check is performed on the value passed in.

Parameters:

	paramName	The partial or full name of the parameter to be modified.
	value	The integer value to be placed in the integer's value data member.

Exceptions:

iException

(IsisProgrammerError) The parameter is not of type "int".

Definition at line 291 of file IsisAml.cpp.

References _FILEINFO_, Isis::IException::Programmer, IsisAml::ReturnParam(), Isis::toString(), and IsisAml::Verify().

void IsisAml::PutString	(	const QString &	paramName,
		const QString &	value
	)			`[inherited]`

Allows the insertion of a value for any parameter.

No validity check is performed on the value passed in.

Parameters:

	paramName	The partial or full name of the parameter to be modified.
	value	The QString representation of the value to be placed in the parameters value data member. For parameters of type integer, the QString must be convertable to an integer. For parameters of type double, the QString must be convertable to a double. For parameters of type boolean, the QString must be one of: (TRUE, FALSE, YES, NO, or a partial match of any of these beginning with the first character).

Definition at line 144 of file IsisAml.cpp.

References _FILEINFO_, Isis::IException::Programmer, IsisAml::ReturnParam(), and IsisAml::Verify().

std::vector< QString > Isis::UserInterface::ReadArray ( QString arrayString ) [private]

This interprets an array value from the command line.

Parameters:

arrayString

Parameter value containing an array of format (a,b,c)

Returns:: std::vector<QString> Values in the array QString

Definition at line 352 of file UserInterface.cpp.

References _FILEINFO_, pos, and Isis::IException::User.

Referenced by GetNextParameter().

const IsisParameterData * IsisAml::ReturnParam ( const QString & paramName ) const [protected, inherited]

Returns a pointer to a parameter whose name starts with paramName.

Parameters:

paramName

The name of the parameter to return

Returns:: IsisParameterData

Exceptions:

	iException::User	(Parameter is not unique)
	iException::User	(Unknown Parameter)

Definition at line 1981 of file IsisAml.cpp.

References _FILEINFO_, g, Isis::IString::UpCase(), and Isis::IException::User.

Referenced by IsisAml::Clear(), IsisAml::CommandLine(), IsisAml::GetAsString(), IsisAml::GetBoolean(), IsisAml::GetDouble(), IsisAml::GetFileName(), IsisAml::GetInputAttribute(), IsisAml::GetInteger(), IsisAml::GetOutputAttribute(), IsisAml::GetString(), LoadHistory(), IsisAml::PutAsString(), IsisAml::PutBoolean(), IsisAml::PutDouble(), IsisAml::PutFileName(), IsisAml::PutInteger(), IsisAml::PutString(), IsisAml::VerifyAll(), and IsisAml::WasEntered().

void Isis::UserInterface::SaveHistory ( )

Saves the user parameter information in the history of the program for later use.

Definition at line 880 of file UserInterface.cpp.

References Isis::PvlObject::AddGroup(), IsisAml::CommandLine(), Isis::PvlObject::DeleteGroup(), Isis::PvlObject::FindGroup(), Isis::PvlObject::Groups(), p_saveFile, IsisAml::ProgramName(), Isis::Pvl::Read(), Isis::toInt(), Isis::PvlObject::Traverse, and Isis::Pvl::Write().

Referenced by Isis::Application::Run(), and Isis::Gui::StartProcess().

void Isis::UserInterface::SetBatchList ( int i )

Clears the gui parameters and sets the batch list information at line i as the new parameters.

Parameters:

i

The line number to retrieve parameter information from

Definition at line 936 of file UserInterface.cpp.

References _FILEINFO_, IsisAml::Clear(), GetNextParameter(), IsisAml::NumGroups(), IsisAml::NumParams(), p_batchList, p_cmdline, p_progName, IsisAml::ParamName(), IsisAml::PutAsString(), Isis::toInt(), Isis::IString::Token(), Isis::IString::ToQt(), Isis::IException::User, and IsisAml::VerifyAll().

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

void Isis::UserInterface::SetErrorList ( int i )

This method adds the line specified in the BatchList that the error occured on.

The BatchList line is added exactly as it is seen, so the BatchList command can be run on the errorlist file created.

Parameters:

i

The line of the batchlist to write to the error file

Definition at line 1022 of file UserInterface.cpp.

References _FILEINFO_, p_batchList, p_errList, size, and Isis::IException::User.

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

bool IsisAml::StringToBool ( QString value ) const [inherited]

Returns a boolean value based on the QString contents.

Parameters:

value

The value to convert to a boolean

Returns:: boolean value based on QString contents

Exceptions:

iException::Programmer

(Invalid boolean value)

Definition at line 2883 of file IsisAml.cpp.

References _FILEINFO_, and Isis::IException::Programmer.

Referenced by IsisAml::Verify(), and IsisAml::VerifyAll().

Gui* Isis::UserInterface::TheGui ( ) [inline]

Returns:: the Gui

Definition at line 147 of file UserInterface.h.

References p_gui.

Referenced by Isis::Application::FunctionCleanup(), Isis::Application::FunctionError(), Isis::GuiEditFile::GuiEditFile(), Isis::Application::GuiLog(), Isis::Application::GuiReportError(), Isis::Application::Log(), Isis::Application::ProcessGuiEvents(), Isis::Application::Run(), and Isis::Application::UpdateProgress().

void IsisAml::VerifyAll ( ) [inherited]

Verify all parameters.

Definition at line 2403 of file IsisAml.cpp.

References _FILEINFO_, g, IsisAml::GetAsString(), IsisAml::GetDouble(), IsisAml::GetInteger(), IsisAml::GetString(), Isis::IException::Programmer, IsisAml::ReturnParam(), IsisAml::StringToBool(), Isis::IException::User, and IsisAml::Verify().

Referenced by Isis::Application::Run(), SetBatchList(), and Isis::Gui::StartProcess().

QString IsisAml::Version ( ) const [inherited]

Returns the application version date.

Returns:: The application version date

Definition at line 3003 of file IsisAml.cpp.

References st.

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

bool IsisAml::WasEntered ( const QString & paramName ) const [inherited]

Returns a true if the parameter has a value, and false if it does not.

Parameters:

paramName

The name of the parameter to check if it was entered

Returns:: True if the parameter was entered, and false if it was not

Definition at line 1852 of file IsisAml.cpp.

References IsisAml::ReturnParam().

Referenced by Isis::PipelineApplication::AddParameter(), Isis::Pipeline::SetInputFile(), Isis::Pipeline::SetOutputFile(), Isis::Pipeline::SetOutputListFile(), Isis::GuiParameter::SetToCurrent(), and Isis::GuiParameter::Update().

Member Data Documentation

bool Isis::UserInterface::p_abortOnError [private]

Boolean value representing whether to abort or continue on error.

Definition at line 202 of file UserInterface.h.

Referenced by AbortOnError(), EvaluateOption(), LoadCommandLine(), and UserInterface().

std::vector<std::vector<QString> > Isis::UserInterface::p_batchList [private]

Vector of batchlist data.

Definition at line 210 of file UserInterface.h.

Referenced by BatchListSize(), LoadBatchList(), SetBatchList(), and SetErrorList().

std::vector<char *> Isis::UserInterface::p_cmdline [private]

This variable will contain argv.

Definition at line 189 of file UserInterface.h.

Referenced by GetNextParameter(), LoadCommandLine(), and SetBatchList().

QString Isis::UserInterface::p_errList [private]

FileName to write batchlist line that caused error on.

Definition at line 207 of file UserInterface.h.

Referenced by EvaluateOption(), LoadCommandLine(), SetErrorList(), and UserInterface().

Gui* Isis::UserInterface::p_gui [private]

Pointer to the gui object.

Definition at line 216 of file UserInterface.h.

Referenced by IsInteractive(), TheGui(), UserInterface(), and ~UserInterface().

bool Isis::UserInterface::p_info [private]

Boolean value representing if its in debug mode.

Definition at line 214 of file UserInterface.h.

Referenced by EvaluateOption(), GetInfoFlag(), and UserInterface().

QString Isis::UserInterface::p_infoFileName [private]

FileName to save debugging info.

Definition at line 215 of file UserInterface.h.

Referenced by EvaluateOption(), GetInfoFileName(), and UserInterface().

bool Isis::UserInterface::p_interactive [private]

Boolean value representing whether the program is interactive or not.

Definition at line 212 of file UserInterface.h.

Referenced by EvaluateOption(), LoadCommandLine(), and UserInterface().

int Isis::UserInterface::p_parentId [private]

This is a status to indicate if the GUI is running or not.

Definition at line 190 of file UserInterface.h.

Referenced by EvaluateOption(), ParentId(), and UserInterface().

QString Isis::UserInterface::p_progName [private]

Name of program to run.

Definition at line 204 of file UserInterface.h.

Referenced by EvaluateOption(), LoadCommandLine(), and SetBatchList().

QString Isis::UserInterface::p_saveFile [private]

FileName to save last history to.

Definition at line 203 of file UserInterface.h.

Referenced by EvaluateOption(), LoadCommandLine(), SaveHistory(), and UserInterface().

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

src/base/objs/UserInterface/UserInterface.h
src/base/objs/UserInterface/UserInterface.cpp

Isis::UserInterface Class Reference [Application Interface]

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Isis::UserInterface Class Reference
[Application Interface]