USGS

Isis 3.0 Object Programmers' Reference

 Home
Isis::UserInterface

Isis::UserInterface Class Reference
[Application Interface]

#include <UserInterface.h>

Inheritance diagram for Isis::UserInterface:

Inheritance graph
[legend]
Collaboration diagram for Isis::UserInterface:

Collaboration graph
[legend]
List of all members.

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.
Todo:
2005-02-22 Jeff Anderson - add coded and implementation examples to class documentation

Definition at line 102 of file UserInterface.h.

Public Member Functions

 UserInterface (const std::string &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 ()
 return the Gui
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.
std::string GetInfoFileName ()
 This method returns the filename where the debugging info is stored when the "-info" tag is used.
void PutAsString (const std::string &paramName, const std::string &value)
 Allows the insertion of a value for any parameter.
void PutAsString (const std::string &paramName, const std::vector< std::string > &value)
 Allows the insertion of a value for any parameter.
void PutFilename (const std::string &paramName, const std::string &value)
 Allows the insertion of a value for a parameter of type "filename".
void PutFilename (const std::string &paramName, const std::vector< std::string > &value)
 Allows the insertion of a value for a parameter of type "filename".
void PutDouble (const std::string &paramName, const double &value)
 Allows the insertion of a value for a parameter of type "double".
void PutDouble (const std::string &paramName, const std::vector< double > &value)
 Allows the insertion of a value for a parameter of type "double".
void PutInteger (const std::string &paramName, const int &value)
 Allows the insertion of a value for a parameter of type "integer".
void PutInteger (const std::string &paramName, const std::vector< int > &value)
 Allows the insertion of a value for a parameter of type "integer".
void PutBoolean (const std::string &paramName, const bool &value)
 Allows the insertion of a value for a parameter of type "boolean".
void PutBoolean (const std::string &paramName, const std::vector< bool > &value)
 Allows the insertion of a value for a parameter of type "boolean".
void PutString (const std::string &paramName, const std::string &value)
 Allows the insertion of a value for any parameter.
void PutString (const std::string &paramName, const std::vector< std::string > &value)
 Allows the insertion of a value for a parameter of type "string".
std::string GetAsString (const std::string &paramName) const
 Allows the retrieval of a value for a parameter of any type.
void GetAsString (const std::string &paramName, std::vector< std::string > &values) const
 Allows the retrieval of a value for a parameter of any type.
std::string GetFilename (const std::string &paramName, std::string extension="") const
 Allows the retrieval of a value for a parameter of type "filename".
void GetFilename (const std::string &paramName, std::vector< std::string > &values) const
 Allows the retrieval of a value for a parameter of type "filename".
std::string GetString (const std::string &paramName) const
 Allows the retrieval of a value for a parameter of type "string".
void GetString (const std::string &paramName, std::vector< std::string > &values) const
 Allows the retrieval of a value for a parameter of type "string".
int GetInteger (const std::string &paramName) const
 Allows the retrieval of a value for a parameter of type "integer".
void GetInteger (const std::string &paramName, std::vector< int > &values) const
 Allows the retrieval of a value for a parameter of type "integer".
bool GetBoolean (const std::string &paramName) const
 Allows the retrieval of a value for a parameter of type "boolean".
void GetBoolean (const std::string &paramName, std::vector< bool > &values) const
 Allows the retrieval of a value for a parameter of type "boolean".
double GetDouble (const std::string &paramName) const
 Allows the retrieval of a value for a parameter of type "double".
void GetDouble (const std::string &paramName, std::vector< double > &values) const
 Allows the retrieval of a value for a parameter of type "double".
bool WasEntered (const std::string &paramName) const
 Returns a true if the parameter has a value, and false if it does not.
void Clear (const std::string &paramName)
 Clears the value(s) in the named parameter.
Isis::CubeAttributeInput & GetInputAttribute (const std::string &paramName)
 Gets the attributes for an input cube.
Isis::CubeAttributeOutput & GetOutputAttribute (const std::string &paramName)
 Gets the attributes for an output cube.
std::string ProgramName () const
 Returns the Program name.
std::string Brief () const
 Returns the brief description of the program.
std::string Description () const
 Returns the full description of the program.
int NumGroups () const
 Returns the number of groups found in the XML.
std::string GroupName (const int &group) const
 Returns the group name of group[index].
int NumParams (const int &) const
 Returns the number of parameters in a group.
std::string ParamName (const int &group, const int &param) const
 Returns the parameter name.
std::string ParamType (const int &group, const int &param) const
 Returns the parameter type of a parameter in a specified group.
std::string ParamBrief (const int &group, const int &param) const
 Returns the brief description of a parameter in a specified group.
std::string ParamDescription (const int &group, const int &param) const
 Returns the long description of a parameter in a specified group.
std::string ParamMinimum (const int &group, const int &param) const
 Returns the minimum value of a parameter in a specified group.
std::string ParamMinimumInclusive (const int &group, const int &param) const
 Returns whether the minimum value is inclusive or not.
std::string ParamMaximum (const int &group, const int &param) const
 Returns the maximum value of a parameter in a specified group.
std::string ParamMaximumInclusive (const int &group, const int &param) const
 Returns whether the maximum value is inclusive or not.
std::string 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.
std::string ParamGreaterThan (const int &group, const int &param, const int &great) const
 Returns the name of the specified greaterThan parameter.
std::string ParamGreaterThanOrEqual (const int &group, const int &param, const int &great) const
 Returns the name of the specified greaterThanOrEqual parameter.
std::string ParamLessThan (const int &group, const int &param, const int &great) const
 Returns the name of the specified lessThan parameter.
std::string ParamLessThanOrEqual (const int &group, const int &param, const int &les) const
 Returns the name of the specified lessThanOrEqual parameter.
std::string 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.
std::string ParamListValue (const int &group, const int &param, const int &option) const
 Returns the option value for a specific option to a parameter.
std::string ParamListBrief (const int &group, const int &param, const int &option) const
 Returns the brief description for a specific option to a parameter.
std::string 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.
std::string 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.
std::string 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.
std::string ParamDefault (const int &group, const int &param) const
 Returns the default for a parameter in a specified group.
std::string ParamInternalDefault (const int &group, const int &param) const
 Returns the internal default for a parameter in a specified group.
std::string ParamFilter (const int &group, const int &param) const
 Returns the parameter filter for a parameter in a specified group.
std::string ParamPath (const int &group, const int &param) const
 Returns the default path for a filename/cube parameter.
std::string 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.
std::string 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.
std::string ParamInclude (const int &group, const int &param, const int &include) const
 Returns the name of the specified included parameter.
std::string 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.
std::string HelperButtonName (const int &group, const int &param, const int &helper) const
 Returns the name of the helper button.
std::string HelperFunction (const int &group, const int &param, const int &helper) const
 Returns the name of the helper function.
std::string HelperBrief (const int &group, const int &param, const int &helper) const
 Returns the brief description of the helper button.
std::string HelperDescription (const int &group, const int &param, const int &helper) const
 Returns the long description of the helper button.
std::string HelperIcon (const int &group, const int &param, const int &helper) const
 Returns the name of the icon for the helper button.
void VerifyAll ()
 Verify all parameters.
bool StringToBool (Isis::iString value) const
 Returns a boolean value based on the string contents.
void CommandLine (Isis::Pvl &lab) const
 Creates a string which could be used as a command line.
std::string Version () const
 Returns the application version date.

Protected Attributes

std::string name
std::string brief
std::string description
std::vector< IsisGroupData > groups
std::vector< std::string > 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 std::string file)
 Loads the user entered batchlist file into a private variable for later use.
void LoadHistory (const std::string file)
 Loads the previous history for the program.
void EvaluateOption (const std::string name, const std::string value)
 This interprets the "-" options for reserved parameters.
void GetNextParameter (unsigned int &curPos, std::string &name, std::vector< std::string > &value)
 This gets the next parameter in the list of arguments.
std::vector< std::string > ReadArray (iString 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.
std::string p_saveFile
 Filename to save last history to.
std::string p_progName
 Name of program to run.
std::string p_errList
 Filename to write batchlist line that caused error on.
std::vector< std::vector<
std::string > > 		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.
std::string p_infoFileName
 Filename to save debugging info.
Gui * p_gui
 Pointer to the gui object.

Constructor & Destructor Documentation

Isis::UserInterface::UserInterface ( const std::string &  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
argv[] Array of arguments

Definition at line 48 of file UserInterface.cpp.

References Isis::Gui::Create(), 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 80 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 141 of file UserInterface.h.

References p_abortOnError.

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

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 126 of file UserInterface.h.

References p_batchList.

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

string IsisAml::Brief (  )  const [inherited]

Returns the brief description of the program.

Returns:
The brief description.

Definition at line 1074 of file IsisAml.cpp.

References IsisAmlData::brief.

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

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

Clears the value(s) in the named parameter.

Parameters:
paramName The name of the parameter to clear

Definition at line 1761 of file IsisAml.cpp.

References IsisParameterData::inCubeAtt, IsisParameterData::outCubeAtt, IsisParameterData::pixelType, Isis::CubeAttributeInput::Reset(), Isis::CubeAttributeOutput::Reset(), IsisAml::ReturnParam(), Isis::CubeAttributeOutput::Set(), and IsisParameterData::values.

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 string which could be used as a command line.

Parameters:
cont Pvl to put command line information in

Definition at line 2756 of file IsisAml.cpp.

References Isis::PvlObject::AddGroup(), Isis::PvlObject::Clear(), Isis::PvlContainer::DeleteKeyword(), g, IsisAml::GetAsString(), IsisAmlData::groups, Isis::PvlContainer::HasKeyword(), IsisAml::ParamName(), IsisAml::ReturnParam(), and value.

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

string IsisAml::Description (  )  const [inherited]

Returns the full description of the program.

Returns:
The full description.

Definition at line 1084 of file IsisAml.cpp.

References IsisAmlData::description.

void Isis::UserInterface::EvaluateOption ( const std::string  name,
const std::string  value 
) [private]

This interprets the "-" options for reserved parameters.

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

Definition at line 410 of file UserInterface.cpp.

References _FILEINFO_, Isis::PvlObject::AddGroup(), Isis::PvlKeyword::AddValue(), Isis::PvlObject::FindGroup(), Isis::Preference::Load(), LoadBatchList(), LoadHistory(), Isis::iException::Message(), Isis::PvlContainer::Name(), 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(), Isis::Preference::Preferences(), IsisAml::ProgramName(), Isis::Pvl::SetTerminator(), Isis::System(), and Isis::PvlObject::Traverse.

Referenced by LoadCommandLine().

void IsisAml::GetAsString ( const std::string &  paramName,
std::vector< std::string > &  values 
) const [inherited]

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

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

Parameters:
paramName The partial or full name of the parameter to be retrieved.
values The value member of the parameter whose name starts with paramName.
Exceptions:
iException (IsisProgrammerError) The parameter has no value.

Definition at line 579 of file IsisAml.cpp.

References _FILEINFO_, IsisParameterData::defaultValues, Isis::iException::Message(), IsisAml::ReturnParam(), value, and IsisParameterData::values.

string IsisAml::GetAsString ( const std::string &  paramName  )  const [inherited]

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

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

Parameters:
paramName The partial or full name of the parameter to be retrieved.
Returns:
A string representation of the value for the specified parameter.
Exceptions:
iException (IsisProgrammerError) The parameter has no value.

Definition at line 547 of file IsisAml.cpp.

References _FILEINFO_, IsisParameterData::defaultValues, Isis::iException::Message(), IsisAml::ReturnParam(), value, and IsisParameterData::values.

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

void IsisAml::GetBoolean ( const std::string &  paramName,
std::vector< bool > &  values 
) 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.
values The member value of a parameter whose name starts with paramName..
Exceptions:
iException::Programmer (IsisErrorUser) The parameter has no value.

Definition at line 1017 of file IsisAml.cpp.

References _FILEINFO_, IsisParameterData::defaultValues, Isis::iException::Message(), IsisAml::ReturnParam(), IsisAml::StringToBool(), IsisParameterData::type, Isis::iString::UpCase(), value, and IsisParameterData::values.

bool IsisAml::GetBoolean ( const std::string &  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 977 of file IsisAml.cpp.

References _FILEINFO_, IsisParameterData::defaultValues, Isis::iException::Message(), IsisAml::ReturnParam(), IsisAml::StringToBool(), IsisParameterData::type, value, and IsisParameterData::values.

void IsisAml::GetDouble ( const std::string &  paramName,
std::vector< double > &  values 
) 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.
values The value member of a parameter whose name starts with paramName.
Exceptions:
iException::Programmer (IsisErrorUser) The parameter has no value.

Definition at line 933 of file IsisAml.cpp.

References _FILEINFO_, IsisParameterData::defaultValues, Isis::iException::Message(), IsisAml::ReturnParam(), IsisParameterData::type, value, and IsisParameterData::values.

double IsisAml::GetDouble ( const std::string &  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 895 of file IsisAml.cpp.

References _FILEINFO_, IsisParameterData::defaultValues, Isis::iException::Message(), IsisAml::ReturnParam(), IsisParameterData::type, value, and IsisParameterData::values.

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

void IsisAml::GetFilename ( const std::string &  paramName,
std::vector< std::string > &  values 
) 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.
values The value membet of the parameter whose name starts with paramName.

Definition at line 657 of file IsisAml.cpp.

References _FILEINFO_, IsisParameterData::defaultValues, Isis::iException::Message(), IsisAmlData::name, IsisAml::ReturnParam(), IsisParameterData::type, and IsisParameterData::values.

string IsisAml::GetFilename ( const std::string &  paramName,
std::string  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 617 of file IsisAml.cpp.

References _FILEINFO_, IsisParameterData::defaultValues, Isis::iException::Message(), IsisAmlData::name, IsisAml::ReturnParam(), IsisParameterData::type, value, and IsisParameterData::values.

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

std::string Isis::UserInterface::GetInfoFileName (  ) 

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

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

Definition at line 915 of file UserInterface.cpp.

References p_info.

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

Isis::CubeAttributeInput & IsisAml::GetInputAttribute ( const std::string &  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 does nto contain an input file)

Definition at line 1784 of file IsisAml.cpp.

References _FILEINFO_, IsisParameterData::defaultValues, IsisParameterData::fileMode, IsisParameterData::inCubeAtt, Isis::iException::Message(), Isis::CubeAttributeInput::Reset(), IsisAml::ReturnParam(), Isis::CubeAttributeInput::Set(), IsisParameterData::type, value, and IsisParameterData::values.

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

void IsisAml::GetInteger ( const std::string &  paramName,
std::vector< int > &  values 
) 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.
values The value member of a parameter whose name starts with paramName.
Exceptions:
iException::Programmer (IsisErrorUser) The parameter has no value.

Definition at line 850 of file IsisAml.cpp.

References _FILEINFO_, IsisParameterData::defaultValues, Isis::iException::Message(), IsisAml::ReturnParam(), IsisParameterData::type, value, and IsisParameterData::values.

int IsisAml::GetInteger ( const std::string &  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 811 of file IsisAml.cpp.

References _FILEINFO_, IsisParameterData::defaultValues, Isis::iException::Message(), IsisAml::ReturnParam(), IsisParameterData::type, value, and IsisParameterData::values.

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

void Isis::UserInterface::GetNextParameter ( unsigned int &  curPos,
std::string &  name,
std::vector< std::string > &  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 238 of file UserInterface.cpp.

References _FILEINFO_, compare(), Isis::iException::Message(), p_cmdline, ReadArray(), and Isis::iString::Trim().

Referenced by LoadCommandLine(), and SetBatchList().

Isis::CubeAttributeOutput & IsisAml::GetOutputAttribute ( const std::string &  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 does nto contain an output file)

Definition at line 1828 of file IsisAml.cpp.

References _FILEINFO_, IsisParameterData::defaultValues, IsisParameterData::fileMode, Isis::iException::Message(), IsisParameterData::outCubeAtt, IsisParameterData::pixelType, Isis::CubeAttributeOutput::Reset(), IsisAml::ReturnParam(), Isis::CubeAttributeOutput::Set(), IsisParameterData::type, value, and IsisParameterData::values.

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

void IsisAml::GetString ( const std::string &  paramName,
std::vector< std::string > &  values 
) 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.
values The value member of a parameter whose name starts with paramName.
Exceptions:
iException::Programmer (IsisErrorUser) The parameter has no value.

Definition at line 768 of file IsisAml.cpp.

References _FILEINFO_, IsisParameterData::defaultValues, Isis::iException::Message(), IsisAml::ReturnParam(), IsisParameterData::type, value, and IsisParameterData::values.

string IsisAml::GetString ( const std::string &  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 702 of file IsisAml.cpp.

References _FILEINFO_, IsisParameterData::defaultValues, IsisParameterData::listOptions, Isis::iException::Message(), IsisAml::ReturnParam(), IsisParameterData::type, value, and IsisParameterData::values.

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

string 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 1104 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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:
string The brief description of the helper button

Definition at line 1705 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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:
string The name of the helper

Definition at line 1677 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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:
string The long description of the helper button

Definition at line 1719 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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:
string The name of the helper function

Definition at line 1691 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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:
string The name of the helper icon

Definition at line 1733 of file IsisAml.cpp.

References IsisAmlData::groups.

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 1664 of file IsisAml.cpp.

References IsisAmlData::groups.

Referenced by Isis::GuiParameter::AddHelpers(), Isis::GuiBooleanParameter::GuiBooleanParameter(), Isis::GuiCubeParameter::GuiCubeParameter(), Isis::GuiDoubleParameter::GuiDoubleParameter(), Isis::GuiFilenameParameter::GuiFilenameParameter(), Isis::GuiIntegerParameter::GuiIntegerParameter(), Isis::GuiListParameter::GuiListParameter(), and Isis::GuiStringParameter::GuiStringParameter().

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

Indicates if the Isis Graphical User Interface is operating.

Returns:
bool

Definition at line 112 of file UserInterface.h.

References p_gui.

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

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

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

Parameters:
file The batchlist file to load
Exceptions:
Isis::iException::User - The batchlist does not contain any data

Definition at line 648 of file UserInterface.cpp.

References _FILEINFO_, Isis::iString::Compress(), e, Isis::TextFile::GetLine(), Isis::TextFile::LineCount(), Isis::iException::Message(), Isis::TextFile::Open(), p_batchList, Isis::iString::Remove(), Isis::iString::Replace(), size, Isis::iString::Token(), and Isis::iString::Trim().

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 100 of file UserInterface.cpp.

References _FILEINFO_, BatchListSize(), IsisAml::Clear(), compare(), e, EvaluateOption(), GetNextParameter(), Isis::iException::Message(), Isis::Filename::Name(), p_abortOnError, p_cmdline, p_errList, p_interactive, p_progName, p_saveFile, and IsisAml::PutAsString().

Referenced by UserInterface().

void Isis::UserInterface::LoadHistory ( const std::string  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 713 of file UserInterface.cpp.

References _FILEINFO_, Isis::Filename::Exists(), Isis::Filename::Expanded(), g, Isis::iException::Message(), IsisAml::ProgramName(), IsisAml::PutAsString(), and value.

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 1093 of file IsisAml.cpp.

References IsisAmlData::groups.

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 1116 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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 1141 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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 1414 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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 1154 of file IsisAml.cpp.

References IsisAmlData::groups.

string 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 1371 of file IsisAml.cpp.

References IsisAmlData::groups.

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 1628 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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 1490 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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 1452 of file IsisAml.cpp.

References filter(), and IsisAmlData::groups.

Referenced by Isis::GuiFilenameParameter::SelectFile(), and Isis::GuiCubeParameter::SelectFile().

string 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 1296 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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 1311 of file IsisAml.cpp.

References IsisAmlData::groups.

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 1245 of file IsisAml.cpp.

References IsisAmlData::groups.

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 1233 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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 1386 of file IsisAml.cpp.

References IsisAmlData::groups.

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 1640 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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 1433 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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 1326 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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 1341 of file IsisAml.cpp.

References IsisAmlData::groups.

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 1270 of file IsisAml.cpp.

References IsisAmlData::groups.

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 1258 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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 1539 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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 1554 of file IsisAml.cpp.

References IsisAmlData::groups.

string 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 1584 of file IsisAml.cpp.

References IsisAmlData::groups.

Referenced by EvaluateOption(), and Isis::GuiListParameter::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 1569 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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 1614 of file IsisAml.cpp.

References IsisAmlData::groups.

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 1599 of file IsisAml.cpp.

References IsisAmlData::groups.

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 1510 of file IsisAml.cpp.

References IsisAmlData::groups.

Referenced by Isis::GuiParameterFactory::Create(), EvaluateOption(), Isis::GuiListParameter::GuiListParameter(), and Isis::GuiListParameter::Set().

string 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 1524 of file IsisAml.cpp.

References IsisAmlData::groups.

Referenced by EvaluateOption(), Isis::GuiListParameter::GuiListParameter(), Isis::GuiListParameter::Set(), and Isis::GuiListParameter::Value().

string 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 1180 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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 1206 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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 1167 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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 1193 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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 1128 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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 1356 of file IsisAml.cpp.

References IsisAmlData::groups.

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 1283 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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 1220 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string 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 1471 of file IsisAml.cpp.

References IsisAmlData::groups.

Referenced by Isis::GuiFilenameParameter::SelectFile(), and Isis::GuiCubeParameter::SelectFile().

string 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 1401 of file IsisAml.cpp.

References IsisAmlData::groups.

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

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

Returns the parent id.

Returns:
int The parent id

Definition at line 133 of file UserInterface.h.

References p_parentId.

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

string 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 1652 of file IsisAml.cpp.

References IsisAmlData::groups.

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

string IsisAml::ProgramName (  )  const [inherited]

Returns the Program name.

Returns:
The name of the program.

Definition at line 1063 of file IsisAml.cpp.

References IsisAmlData::name.

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 std::string &  paramName,
const std::vector< std::string > &  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 string vector representation of the value to be placed in the parameters value data member. For parameters of type integer, the string must be convertable to an integer. For parameters of type double, the string must be convertable to a double. For parameters of type boolean, the string must be one of: (TRUE, FALSE, YES, NO, or a partial match of any of these beginning with the first character).

Definition at line 103 of file IsisAml.cpp.

References _FILEINFO_, Isis::iException::Message(), IsisAml::ReturnParam(), and IsisParameterData::values.

void IsisAml::PutAsString ( const std::string &  paramName,
const std::string &  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 string representation of the value to be placed in the parameters value data member. For parameters of type integer, the string must be convertable to an integer. For parameters of type double, the string must be convertable to a double. For parameters of type boolean, the string must be one of: (TRUE, FALSE, YES, NO, or a partial match of any of these beginning with the first character).
Exceptions:
iException (IsisUserError) 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 75 of file IsisAml.cpp.

References _FILEINFO_, Isis::iException::Message(), IsisAml::ReturnParam(), and IsisParameterData::values.

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

void IsisAml::PutBoolean ( const std::string &  paramName,
const std::vector< 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 vector 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 502 of file IsisAml.cpp.

References _FILEINFO_, Isis::iException::Message(), IsisAml::ReturnParam(), IsisParameterData::type, IsisParameterData::values, and IsisAml::Verify().

void IsisAml::PutBoolean ( const std::string &  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 456 of file IsisAml.cpp.

References _FILEINFO_, Isis::iException::Message(), IsisAml::ReturnParam(), IsisParameterData::type, IsisParameterData::values, and IsisAml::Verify().

void IsisAml::PutDouble ( const std::string &  paramName,
const std::vector< 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 vector 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 412 of file IsisAml.cpp.

References _FILEINFO_, Isis::iException::Message(), IsisAml::ReturnParam(), IsisParameterData::type, IsisParameterData::values, and IsisAml::Verify().

void IsisAml::PutDouble ( const std::string &  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 371 of file IsisAml.cpp.

References _FILEINFO_, Isis::iException::Message(), IsisAml::ReturnParam(), IsisParameterData::type, IsisParameterData::values, and IsisAml::Verify().

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

void IsisAml::PutFilename ( const std::string &  paramName,
const std::vector< std::string > &  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 string vector representation of the value to be placed in the filename's value data member.
Exceptions:
iException (IsisProgrammerError) The parameter is not of type "filename".
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.

Definition at line 247 of file IsisAml.cpp.

References _FILEINFO_, Isis::iException::Message(), IsisAml::ReturnParam(), IsisParameterData::type, IsisParameterData::values, and IsisAml::Verify().

void IsisAml::PutFilename ( const std::string &  paramName,
const std::string &  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 string representation of the value to be placed in the filename's value data member.

Definition at line 205 of file IsisAml.cpp.

References _FILEINFO_, Isis::iException::Message(), IsisAml::ReturnParam(), IsisParameterData::type, IsisParameterData::values, and IsisAml::Verify().

void IsisAml::PutInteger ( const std::string &  paramName,
const std::vector< 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 vector to be placed in the integer'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 "int".

Definition at line 326 of file IsisAml.cpp.

References _FILEINFO_, Isis::iException::Message(), IsisAml::ReturnParam(), IsisParameterData::type, IsisParameterData::values, and IsisAml::Verify().

void IsisAml::PutInteger ( const std::string &  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 285 of file IsisAml.cpp.

References _FILEINFO_, Isis::iException::Message(), IsisAml::ReturnParam(), IsisParameterData::type, IsisParameterData::values, and IsisAml::Verify().

void IsisAml::PutString ( const std::string &  paramName,
const std::vector< std::string > &  value 
) [inherited]

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

A validity check is performed on the value passed in, but all strings are allowed.

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

Definition at line 170 of file IsisAml.cpp.

References _FILEINFO_, Isis::iException::Message(), IsisAml::ReturnParam(), IsisParameterData::type, IsisParameterData::values, and IsisAml::Verify().

void IsisAml::PutString ( const std::string &  paramName,
const std::string &  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 string representation of the value to be placed in the parameters value data member. For parameters of type integer, the string must be convertable to an integer. For parameters of type double, the string must be convertable to a double. For parameters of type boolean, the string must be one of: (TRUE, FALSE, YES, NO, or a partial match of any of these beginning with the first character).

Definition at line 138 of file IsisAml.cpp.

References _FILEINFO_, Isis::iException::Message(), IsisAml::ReturnParam(), IsisParameterData::type, IsisParameterData::values, and IsisAml::Verify().

std::vector< std::string > Isis::UserInterface::ReadArray ( iString  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<std::string> Values in the array string

Definition at line 319 of file UserInterface.cpp.

References _FILEINFO_, and Isis::iException::Message().

Referenced by GetNextParameter().

void Isis::UserInterface::SaveHistory (  ) 

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

Definition at line 766 of file UserInterface.cpp.

References Isis::PvlObject::AddGroup(), IsisAml::CommandLine(), Isis::PvlObject::DeleteGroup(), e, Isis::Filename::Exists(), Isis::Filename::Expanded(), Isis::PvlObject::FindGroup(), Isis::PvlObject::Groups(), p_saveFile, Isis::Preference::Preferences(), IsisAml::ProgramName(), Isis::Pvl::Read(), Isis::PvlObject::Traverse, and Isis::Pvl::Write().

Referenced by Isis::Application::Exec(), 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 815 of file UserInterface.cpp.

References _FILEINFO_, IsisAml::Clear(), e, GetNextParameter(), Isis::iException::Message(), IsisAml::NumGroups(), IsisAml::NumParams(), p_batchList, p_cmdline, p_progName, IsisAml::ParamName(), IsisAml::PutAsString(), ToInteger(), value, and IsisAml::VerifyAll().

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

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 890 of file UserInterface.cpp.

References _FILEINFO_, Isis::iException::Message(), p_batchList, p_errList, and size.

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

bool IsisAml::StringToBool ( Isis::iString  value  )  const [inherited]

Returns a boolean value based on the string contents.

Parameters:
value The value to convert to a boolean
Returns:
boolean value based on string contents
Exceptions:
iException::Programmer (Invalid boolean value)

Definition at line 2713 of file IsisAml.cpp.

References _FILEINFO_, Isis::iException::Message(), and value.

Referenced by IsisAml::GetBoolean(), Isis::GuiBooleanParameter::Set(), IsisAml::Verify(), and IsisAml::VerifyAll().

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

return the Gui

Definition at line 117 of file UserInterface.h.

References p_gui.

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

void IsisAml::VerifyAll (  )  [inherited]

Verify all parameters.

Definition at line 2233 of file IsisAml.cpp.

References _FILEINFO_, IsisParameterData::defaultValues, g, IsisAml::GetAsString(), IsisAml::GetDouble(), IsisAml::GetInteger(), IsisAml::GetString(), IsisAmlData::groups, IsisParameterData::internalDefault, Isis::iException::Message(), IsisParameterData::name, IsisAml::ReturnParam(), IsisAml::StringToBool(), IsisParameterData::type, value, IsisParameterData::values, and IsisAml::Verify().

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

string IsisAml::Version (  )  const [inherited]

Returns the application version date.

Returns:
The application version date

Definition at line 2819 of file IsisAml.cpp.

References IsisAmlData::changes, and st.

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

bool IsisAml::WasEntered ( const std::string &  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 1745 of file IsisAml.cpp.

References IsisAml::ReturnParam(), and IsisParameterData::values.

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 164 of file UserInterface.h.

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

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

Vector of batchlist data.

Definition at line 172 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 151 of file UserInterface.h.

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

std::string Isis::UserInterface::p_errList [private]

Filename to write batchlist line that caused error on.

Definition at line 169 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 178 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 176 of file UserInterface.h.

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

std::string Isis::UserInterface::p_infoFileName [private]

Filename to save debugging info.

Definition at line 177 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 174 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 152 of file UserInterface.h.

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

std::string Isis::UserInterface::p_progName [private]

Name of program to run.

Definition at line 166 of file UserInterface.h.

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

std::string Isis::UserInterface::p_saveFile [private]

Filename to save last history to.

Definition at line 165 of file UserInterface.h.

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

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