Isis Developer Reference
|
Command Line and Xml loader, validation, and access. More...
#include <UserInterface.h>
Public Member Functions | |
UserInterface (const QString &xmlfile, int &argc, char *argv[]) | |
Constructs an UserInterface object. | |
UserInterface (const QString &xmlfile, QVector< QString > &args) | |
Constructs an UserInterface object. | |
~UserInterface () | |
Destroys the UserInterface object. | |
bool | AbortOnError () |
Returns true if the program should abort on error, and false if it should continue. | |
int | BatchListSize () |
Returns the size of the batchlist. | |
bool | IsInteractive () |
Indicates if the Isis Graphical User Interface is operating. | |
int | ParentId () |
Returns the parent id. | |
Gui * | TheGui () |
QString | GetParamPreference () |
Get the the preference path passed in by the user. | |
QString | GetInfoFileName () |
This method returns the filename where the debugging info is stored when the "-info" tag is used. | |
bool | GetInfoFlag () |
This method returns the flag state of info. | |
QString | BuildNewCommandLineFromPvl (Pvl temp) |
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. | |
void | SaveHistory () |
Saves the user parameter information in the history of the program for later use. | |
void | PutAsString (const QString ¶mName, const QString &value) |
Allows the insertion of a value for any parameter. | |
void | PutAsString (const QString ¶mName, const std::vector< QString > &value) |
void | PutFileName (const QString ¶mName, const QString &value) |
Allows the insertion of a value for a parameter of type "filename". | |
void | PutFileName (const QString ¶mName, const std::vector< QString > &value) |
void | PutCubeName (const QString ¶mName, const QString &value) |
Allows the insertion of a value for a parameter of type "cubename". | |
void | PutDouble (const QString ¶mName, const double &value) |
Allows the insertion of a value for a parameter of type "double". | |
void | PutDouble (const QString ¶mName, const std::vector< double > &value) |
void | PutInteger (const QString ¶mName, const int &value) |
Allows the insertion of a value for a parameter of type "integer". | |
void | PutInteger (const QString ¶mName, const std::vector< int > &value) |
void | PutBoolean (const QString ¶mName, const bool &value) |
Allows the insertion of a value for a parameter of type "boolean". | |
void | PutBoolean (const QString ¶mName, const std::vector< bool > &value) |
void | PutString (const QString ¶mName, const QString &value) |
Allows the insertion of a value for any parameter. | |
void | PutString (const QString ¶mName, const std::vector< QString > &value) |
QString | GetAsString (const QString ¶mName) const |
Allows the retrieval of a value for a parameter of any type. | |
void | GetAsString (const QString ¶mName, std::vector< QString > &values) const |
QString | GetFileName (const QString ¶mName, QString extension="") const |
Allows the retrieval of a value for a parameter of type "filename". | |
void | GetFileName (const QString ¶mName, std::vector< QString > &values) const |
QString | GetCubeName (const QString ¶mName, QString extension="") const |
Retrieves of a value for a parameter of type "cubename". | |
QString | GetString (const QString ¶mName) const |
Allows the retrieval of a value for a parameter of type "string". | |
void | GetString (const QString ¶mName, std::vector< QString > &values) const |
int | GetInteger (const QString ¶mName) const |
Allows the retrieval of a value for a parameter of type "integer". | |
void | GetInteger (const QString ¶mName, std::vector< int > &values) const |
bool | GetBoolean (const QString ¶mName) const |
Allows the retrieval of a value for a parameter of type "boolean". | |
void | GetBoolean (const QString ¶mName, std::vector< bool > &values) const |
double | GetDouble (const QString ¶mName) const |
Allows the retrieval of a value for a parameter of type "double". | |
void | GetDouble (const QString ¶mName, std::vector< double > &values) const |
bool | WasEntered (const QString ¶mName) const |
Returns a true if the parameter has a value, and false if it does not. | |
void | Clear (const QString ¶mName) |
Clears the value(s) in the named parameter. | |
Isis::CubeAttributeInput & | GetInputAttribute (const QString ¶mName) |
Gets the attributes for an input cube. | |
Isis::CubeAttributeOutput & | GetOutputAttribute (const QString ¶mName) |
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. | |
nlohmann::json | GetParams () |
Creates a json object which could be used as a command line. | |
int | NumParams (const int &) const |
Returns the number of parameters in a group. | |
QString | ParamName (const int &group, const int ¶m) const |
Returns the parameter name. | |
QString | ParamType (const int &group, const int ¶m) const |
Returns the parameter type of a parameter in a specified group. | |
QString | ParamBrief (const int &group, const int ¶m) const |
Returns the brief description of a parameter in a specified group. | |
QString | ParamDescription (const int &group, const int ¶m) const |
Returns the long description of a parameter in a specified group. | |
QString | ParamMinimum (const int &group, const int ¶m) const |
Returns the minimum value of a parameter in a specified group. | |
QString | ParamMinimumInclusive (const int &group, const int ¶m) const |
Returns whether the minimum value is inclusive or not. | |
QString | ParamMaximum (const int &group, const int ¶m) const |
Returns the maximum value of a parameter in a specified group. | |
QString | ParamMaximumInclusive (const int &group, const int ¶m) const |
Returns whether the maximum value is inclusive or not. | |
QString | ParamOdd (const int &group, const int ¶m) const |
Returns whether the selected parameter has a restriction on odd values or not. | |
int | ParamGreaterThanSize (const int &group, const int ¶m) const |
Returns the number of values in the parameters greater than list. | |
int | ParamGreaterThanOrEqualSize (const int &group, const int ¶m) const |
Returns the number of values in the parameters greater than or equal list. | |
int | ParamLessThanSize (const int &group, const int ¶m) const |
Returns the number of values in the parameters less than list. | |
int | ParamLessThanOrEqualSize (const int &group, const int ¶m) const |
Returns the number of values in the parameters less than or equal list. | |
int | ParamNotEqualSize (const int &group, const int ¶m) const |
Returns the number of values in the not equal list. | |
QString | ParamGreaterThan (const int &group, const int ¶m, const int &great) const |
Returns the name of the specified greaterThan parameter. | |
QString | ParamGreaterThanOrEqual (const int &group, const int ¶m, const int &great) const |
Returns the name of the specified greaterThanOrEqual parameter. | |
QString | ParamLessThan (const int &group, const int ¶m, const int &great) const |
Returns the name of the specified lessThan parameter. | |
QString | ParamLessThanOrEqual (const int &group, const int ¶m, const int &les) const |
Returns the name of the specified lessThanOrEqual parameter. | |
QString | ParamNotEqual (const int &group, const int ¶m, const int ¬Eq) const |
Returns the name of the specified notEqual parameter. | |
int | ParamListSize (const int &group, const int ¶m) const |
Returns the number of options in the specified parameter's list. | |
QString | ParamListValue (const int &group, const int ¶m, const int &option) const |
Returns the option value for a specific option to a parameter. | |
QString | ParamListBrief (const int &group, const int ¶m, const int &option) const |
Returns the brief description for a specific option to a parameter. | |
QString | ParamListDescription (const int &group, const int ¶m, const int &option) const |
Returns the full description for a specific option to a parameter. | |
int | ParamListExcludeSize (const int &group, const int ¶m, const int &option) const |
Returns the number of items in a parameters list exclude section. | |
QString | ParamListExclude (const int &group, const int ¶m, 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 ¶m, const int &option) const |
Returns the number of items in a parameters list include section. | |
QString | ParamListInclude (const int &group, const int ¶m, 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 ¶m) const |
Returns the default for a parameter in a specified group. | |
QString | ParamInternalDefault (const int &group, const int ¶m) const |
Returns the internal default for a parameter in a specified group. | |
QString | ParamFilter (const int &group, const int ¶m) const |
Returns the parameter filter for a parameter in a specified group. | |
QString | ParamPath (const int &group, const int ¶m) const |
Returns the default path for a filename/cube parameter. | |
QString | ParamFileMode (const int &group, const int ¶m) const |
Returns the file mode for a parameter in a specified group. | |
int | ParamExcludeSize (const int &group, const int ¶m) const |
Returns the number of parameters excluded in this parameter's exclusions. | |
QString | ParamExclude (const int &group, const int ¶m, const int &exclude) const |
Returns the name of the specified excluded parameter. | |
int | ParamIncludeSize (const int &group, const int ¶m) const |
Returns the number of parameters included in this parameter's inclusions. | |
QString | ParamInclude (const int &group, const int ¶m, const int &include) const |
Returns the name of the specified included parameter. | |
QString | PixelType (const int &group, const int ¶m) const |
Returns the default pixel type from the XML. | |
int | HelpersSize (const int &group, const int ¶m) const |
Returns the number of helpers the parameter has. | |
QString | HelperButtonName (const int &group, const int ¶m, const int &helper) const |
Returns the name of the helper button. | |
QString | HelperFunction (const int &group, const int ¶m, const int &helper) const |
Returns the name of the helper function. | |
QString | HelperBrief (const int &group, const int ¶m, const int &helper) const |
Returns the brief description of the helper button. | |
QString | HelperDescription (const int &group, const int ¶m, const int &helper) const |
Returns the long description of the helper button. | |
QString | HelperIcon (const int &group, const int ¶m, const int &helper) const |
Returns the name of the icon for the helper button. | |
bool | IsParamInPvlInclude (QString ¶mName, 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 ¶mName) 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 |
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.
Isis::UserInterface::UserInterface | ( | const QString & | xmlfile, |
int & | argc, | ||
char * | argv[] ) |
Constructs an UserInterface object.
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 |
References Isis::Gui::checkX11(), Isis::Gui::Create(), and Isis::FileName::dir().
Isis::UserInterface::UserInterface | ( | const QString & | xmlfile, |
QVector< QString > & | args ) |
Constructs an UserInterface object.
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 |
References Isis::FileName::dir().
Isis::UserInterface::~UserInterface | ( | ) |
Destroys the UserInterface object.
|
inline |
Returns true if the program should abort on error, and false if it should continue.
Referenced by Isis::Application::Run().
|
inline |
Returns the size of the batchlist.
If there is no batchlist, it will return 0
Referenced by Isis::Application::Run().
|
inherited |
Returns the brief description of the program.
References IsisAmlData::brief.
Referenced by Isis::Application::History().
QString Isis::UserInterface::BuildNewCommandLineFromPvl | ( | Pvl | temp | ) |
References Isis::PvlContainer::keywords(), and Isis::PvlKeyword::name().
|
inherited |
Clears the value(s) in the named parameter.
paramName | The name of the parameter to clear |
References IsisAml::ReturnParam(), and IsisParameterData::values.
Referenced by SetBatchList().
|
inherited |
Creates a QString which could be used as a command line.
cont | Pvl to put command line information in |
References Isis::PvlContainer::deleteKeyword(), IsisAml::GetAsString(), IsisAmlData::groups, Isis::PvlContainer::hasKeyword(), IsisAml::ParamName(), IsisAml::ReturnParam(), Isis::IString::Trim(), and Isis::IString::UpCase().
Referenced by Isis::Application::History(), and SaveHistory().
|
inherited |
Create Pvl with the parameters in a user defined group given the Pvl object and group name.
Create a PVL file from the parameters in a Group given the Gui group name, Pvl Object and Group names and the list of parameters to be included in the Pvl.
pvlDef | - output PVL |
guiGrpName | - Gui Group name |
pvlObjName | - output PVL Object name |
pvlGrpName | - output PVL Group name |
include | - vector of parameter names to be part of the output PVL |
References _FILEINFO_, Isis::IString::DownCase(), IsisAml::GetAsString(), IsisAml::GetBoolean(), IsisAml::GetDouble(), IsisAml::GetInteger(), IsisAml::GroupIndex(), IsisAml::IsParamInPvlInclude(), IsisAml::NumParams(), IsisAml::ParamName(), IsisAml::ParamType(), Isis::toString(), and Isis::IException::User.
|
inherited |
Returns the full description of the program.
References IsisAmlData::description.
|
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.
paramName | The partial or full name of the parameter to be retrieved. |
iException | (IsisProgrammerError) The parameter has no value. |
References _FILEINFO_, Isis::IException::Programmer, and IsisAml::ReturnParam().
Referenced by IsisAml::CommandLine(), IsisAml::CreatePVL(), Isis::GuiParameter::SetToCurrent(), Isis::GuiParameter::Update(), and IsisAml::VerifyAll().
|
inherited |
|
inherited |
Allows the retrieval of a value for a parameter of type "boolean".
paramName | The partial or full name of the parameter to be retrieved. |
iException::Programmer | (IsisErrorUser) The parameter has no value. |
References _FILEINFO_, Isis::IException::Programmer, IsisAml::ReturnParam(), Isis::toBool(), and Isis::IException::User.
Referenced by IsisAml::CreatePVL().
|
inherited |
|
inherited |
Retrieves of a value for a parameter of type "cubename".
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 |
References _FILEINFO_, IsisAmlData::name, Isis::IException::Programmer, IsisAml::ReturnParam(), and Isis::IException::User.
|
inherited |
Allows the retrieval of a value for a parameter of type "double".
paramName | The partial or full name of the parameter to be retrieved. |
iException::Programmer | (IsisErrorUser) The parameter has no value. |
References _FILEINFO_, Isis::IException::Programmer, IsisAml::ReturnParam(), Isis::IString::ToDouble(), and Isis::IException::User.
Referenced by IsisAml::CreatePVL(), and IsisAml::VerifyAll().
|
inherited |
|
inherited |
Allows the retrieval of a value for a parameter of type "filename".
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 |
References _FILEINFO_, IsisAmlData::name, Isis::IException::Programmer, IsisAml::ReturnParam(), and Isis::IException::User.
|
inherited |
QString Isis::UserInterface::GetInfoFileName | ( | ) |
This method returns the filename where the debugging info is stored when the "-info" tag is used.
bool Isis::UserInterface::GetInfoFlag | ( | ) |
This method returns the flag state of info.
This returns if its in debugging mode(the -info tag was specified).
|
inherited |
Gets the attributes for an input cube.
paramName | The name of the parameter to get the attributes for |
iException::Programmer | "Parameter is not a cube." |
iException::Programmer | "Parameter in not an input cube" |
References _FILEINFO_, Isis::IException::Programmer, IsisAml::ReturnParam(), and IsisParameterData::type.
|
inherited |
Allows the retrieval of a value for a parameter of type "integer".
paramName | The partial or full name of the parameter to be retrieved. |
iException::Programmer | (IsisErrorUser) The parameter has no value. |
References _FILEINFO_, Isis::IException::Programmer, IsisAml::ReturnParam(), Isis::IString::ToInteger(), and Isis::IException::User.
Referenced by IsisAml::CreatePVL(), and IsisAml::VerifyAll().
|
inherited |
|
inherited |
Gets the attributes for an output cube.
paramName | The name of the parameter to get the attributes for |
iException::Programmer | "Parameter is not a cube" |
iException::Programmer | "Parameter in not an output" |
References _FILEINFO_, Isis::IException::Programmer, IsisAml::ReturnParam(), and IsisParameterData::type.
|
inline |
Get the the preference path passed in by the user.
Otherwise an empty string
|
inherited |
Creates a json object which could be used as a command line.
References IsisAmlData::groups, IsisAml::ParamName(), and IsisAml::ReturnParam().
|
inherited |
Allows the retrieval of a value for a parameter of type "string".
paramName | The partial or full name of the parameter to be retrieved. |
iException::Programmer | (IsisErrorUser) The parameter has no value. |
References _FILEINFO_, Isis::IException::Programmer, IsisAml::ReturnParam(), and Isis::IException::User.
Referenced by IsisAml::VerifyAll().
|
inherited |
|
inherited |
Given the group name get its index in group array.
Given group name return its index in the Gui.
grpName |
References Isis::IString::DownCase(), IsisAmlData::groups, and IsisAmlData::name.
Referenced by IsisAml::CreatePVL().
|
inherited |
Returns the group name of group[index].
index | The array index of the group. |
References IsisAmlData::groups.
|
inherited |
Returns the brief description of the helper button.
group | The group index |
param | The parameter index |
helper | The helper index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::AddHelpers().
|
inherited |
Returns the name of the helper button.
group | The group index |
param | The parameter index |
helper | The helper index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::AddHelpers().
|
inherited |
Returns the long description of the helper button.
group | The group index |
param | The parameter index |
helper | The helper index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::AddHelpers().
|
inherited |
Returns the name of the helper function.
group | The group index |
param | The parameter index |
helper | The helper index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::AddHelpers().
|
inherited |
Returns the name of the icon for the helper button.
group | The group index |
param | The parameter index |
helper | The helper index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::AddHelpers().
|
inherited |
Returns the number of helpers the parameter has.
group | The group index |
param | The parameter index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::AddHelpers(), Isis::GuiBooleanParameter::GuiBooleanParameter(), Isis::GuiDoubleParameter::GuiDoubleParameter(), Isis::GuiFileNameParameter::GuiFileNameParameter(), Isis::GuiIntegerParameter::GuiIntegerParameter(), Isis::GuiListParameter::GuiListParameter(), and Isis::GuiStringParameter::GuiStringParameter().
|
inline |
Indicates if the Isis Graphical User Interface is operating.
Referenced by Isis::Application::Application(), Isis::Application::History(), and Isis::Application::Run().
|
inherited |
Verify whether Parameter name is in the Include list Used in creation of DefFile.
Verify if the Parameter is in the Included list.
paramName | - parameter name |
include | - include list |
References Isis::IString::DownCase().
Referenced by IsisAml::CreatePVL().
|
inherited |
Returns the number of groups found in the XML.
References IsisAmlData::groups.
Referenced by SetBatchList().
|
inherited |
Returns the number of parameters in a group.
group | The group to measure. |
References IsisAmlData::groups.
Referenced by IsisAml::CreatePVL(), and SetBatchList().
|
inherited |
Returns the brief description of a parameter in a specified group.
group | The group index |
param | The parameter index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::GuiParameter().
|
inherited |
Returns the default for a parameter in a specified group.
group | The group index |
param | The parameter index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::GuiParameter(), Isis::GuiBooleanParameter::IsModified(), Isis::GuiParameter::IsModified(), Isis::GuiParameter::SetToDefault(), and Isis::GuiParameter::Update().
|
inherited |
Returns the long description of a parameter in a specified group.
group | The group index |
param | The parameter index |
References IsisAmlData::groups.
|
inherited |
Returns the name of the specified excluded parameter.
group | The group index |
param | The parameter index |
exclude | The exclude index |
References IsisAmlData::groups.
Referenced by Isis::GuiBooleanParameter::Exclusions(), and Isis::GuiParameter::GuiParameter().
|
inherited |
Returns the number of parameters excluded in this parameter's exclusions.
group | The group index |
param | The parameter index |
References IsisAmlData::groups.
Referenced by Isis::GuiBooleanParameter::Exclusions(), and Isis::GuiParameter::GuiParameter().
|
inherited |
Returns the file mode for a parameter in a specified group.
group | The group index |
param | The parameter index |
References IsisAmlData::groups.
Referenced by Isis::GuiFileNameParameter::SelectFile().
|
inherited |
Returns the parameter filter for a parameter in a specified group.
group | The group index |
param | The parameter index |
References IsisAmlData::groups.
Referenced by Isis::GuiFileNameParameter::SelectFile().
|
inherited |
Returns the name of the specified greaterThan parameter.
group | The group index |
param | The parameter index |
great | The greaterThan index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::GuiParameter().
|
inherited |
Returns the name of the specified greaterThanOrEqual parameter.
group | The group index |
param | The parameter index |
great | The greaterThanOrEqual index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::GuiParameter().
|
inherited |
Returns the number of values in the parameters greater than or equal list.
group | The group index |
param | The parameter index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::GuiParameter().
|
inherited |
Returns the number of values in the parameters greater than list.
group | The group index |
param | The parameter index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::GuiParameter().
|
inherited |
Returns the name of the specified included parameter.
group | The group index |
param | The parameter index |
include | The include index |
References IsisAmlData::groups.
Referenced by Isis::GuiBooleanParameter::Exclusions(), and Isis::GuiParameter::GuiParameter().
|
inherited |
Returns the number of parameters included in this parameter's inclusions.
group | The group index |
param | The parameter index |
References IsisAmlData::groups.
Referenced by Isis::GuiBooleanParameter::Exclusions(), and Isis::GuiParameter::GuiParameter().
|
inherited |
Returns the internal default for a parameter in a specified group.
.
group | The group index |
param | The parameter index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::GuiParameter(), Isis::GuiParameter::IsModified(), Isis::GuiFileNameParameter::SelectFile(), Isis::GuiParameter::SetToDefault(), and Isis::GuiParameter::Update().
|
inherited |
Returns the name of the specified lessThan parameter.
group | The group index |
param | The parameter index |
les | The lessThan index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::GuiParameter().
|
inherited |
Returns the name of the specified lessThanOrEqual parameter.
group | The group index |
param | The parameter index |
les | The lessThanOrEqual index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::GuiParameter().
|
inherited |
Returns the number of values in the parameters less than or equal list.
group | The group index |
param | The parameter index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::GuiParameter().
|
inherited |
Returns the number of values in the parameters less than list.
group | The group index |
param | The parameter index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::GuiParameter().
|
inherited |
Returns the brief description for a specific option to a parameter.
group | The group index |
param | The parameter index |
option | The option number within the parameters list. |
References IsisAmlData::groups.
|
inherited |
Returns the full description for a specific option to a parameter.
group | The group index |
param | The parameter index |
option | The option number within the parameters list. |
References IsisAmlData::groups.
|
inherited |
Returns the parameter name to be excluded if this option is selected.
group | The group index |
param | The parameter index |
option | The option number within the parameters list. |
exclude | The exclusion number within the parameters list. |
References IsisAmlData::groups.
Referenced by Isis::GuiComboBoxParameter::Exclusions(), and Isis::GuiListParameter::Exclusions().
|
inherited |
Returns the number of items in a parameters list exclude section.
group | The group index |
param | The parameter index |
option | The option number within the parameters list. |
References IsisAmlData::groups.
Referenced by Isis::GuiComboBoxParameter::Exclusions(), and Isis::GuiListParameter::Exclusions().
|
inherited |
Returns the parameter name to be included if this option is selected.
group | The group index |
param | The parameter index |
option | The option number within the parameters list. |
include | The inclusion number within the parameters list. |
References IsisAmlData::groups.
|
inherited |
Returns the number of items in a parameters list include section.
group | The group index |
param | The parameter index |
option | The option number within the parameters list. |
References IsisAmlData::groups.
|
inherited |
Returns the number of options in the specified parameter's list.
group | The group index |
param | The parameter index |
References IsisAmlData::groups.
Referenced by Isis::GuiComboBoxParameter::Set(), and Isis::GuiListParameter::Set().
|
inherited |
Returns the option value for a specific option to a parameter.
group | The group index |
param | The parameter index |
option | The option number within the parameters list. |
References IsisAmlData::groups.
Referenced by Isis::GuiComboBoxParameter::Set(), Isis::GuiListParameter::Set(), Isis::GuiComboBoxParameter::Value(), and Isis::GuiListParameter::Value().
|
inherited |
Returns the maximum value of a parameter in a specified group.
group | The group index |
param | The parameter index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::GuiParameter().
|
inherited |
Returns whether the maximum value is inclusive or not.
group | The group index |
param | The parameter index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::GuiParameter().
|
inherited |
Returns the minimum value of a parameter in a specified group.
group | The group index |
param | The parameter index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::GuiParameter().
|
inherited |
Returns whether the minimum value is inclusive or not.
group | The group index |
param | The parameter index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::GuiParameter().
|
inherited |
Returns the parameter name.
group | The group index where the parameter can be found. |
param | The index of the parameter to name. |
References IsisAmlData::groups.
Referenced by IsisAml::CommandLine(), IsisAml::CreatePVL(), IsisAml::GetParams(), Isis::GuiParameter::GuiParameter(), and SetBatchList().
|
inherited |
Returns the name of the specified notEqual parameter.
group | The group index |
param | The parameter index |
notEq | The notEqual index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::GuiParameter().
|
inherited |
Returns the number of values in the not equal list.
group | The group index |
param | The parameter index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::GuiParameter().
|
inherited |
Returns whether the selected parameter has a restriction on odd values or not.
group | The group index |
param | The parameter index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::GuiParameter().
|
inherited |
Returns the default path for a filename/cube parameter.
group | The group index |
param | The parameter index |
References IsisAmlData::groups.
Referenced by Isis::GuiFileNameParameter::SelectFile().
|
inherited |
Returns the parameter type of a parameter in a specified group.
group | The group index |
param | The parameter index |
References IsisAmlData::groups.
Referenced by IsisAml::CreatePVL(), and Isis::GuiParameter::GuiParameter().
|
inline |
|
inherited |
Returns the default pixel type from the XML.
group | The group index |
param | The parameter index |
References IsisAmlData::groups.
Referenced by Isis::GuiParameter::GuiParameter().
|
inherited |
Returns the Program name.
References IsisAmlData::name.
Referenced by Isis::Application::History(), and SaveHistory().
|
inherited |
Allows the insertion of a value for any parameter.
No validity check is performed on the value passed in.
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). |
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. |
References _FILEINFO_, IsisAml::ReturnParam(), and Isis::IException::User.
Referenced by SetBatchList().
|
inherited |
|
inherited |
Allows the insertion of a value for a parameter of type "boolean".
A validity check is performed on the value passed in.
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. |
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". |
References _FILEINFO_, Isis::IException::Programmer, and IsisAml::ReturnParam().
|
inherited |
|
inherited |
Allows the insertion of a value for a parameter of type "cubename".
A validity check is performed on the value passed in.
paramName | The partial or full name of the parameter to be modified. |
value | The QString representation of the value to be placed in the cubename's value data member. |
References _FILEINFO_, Isis::IException::Programmer, and IsisAml::ReturnParam().
|
inherited |
Allows the insertion of a value for a parameter of type "double".
A validity check is performed on the value passed in.
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. |
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". |
References _FILEINFO_, Isis::IException::Programmer, IsisAml::ReturnParam(), and Isis::toString().
|
inherited |
|
inherited |
Allows the insertion of a value for a parameter of type "filename".
A validity check is performed on the value passed in.
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. |
References _FILEINFO_, Isis::IException::Programmer, and IsisAml::ReturnParam().
|
inherited |
|
inherited |
Allows the insertion of a value for a parameter of type "integer".
A validity check is performed on the value passed in.
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. |
iException | (IsisProgrammerError) The parameter is not of type "int". |
References _FILEINFO_, Isis::IException::Programmer, IsisAml::ReturnParam(), and Isis::toString().
|
inherited |
|
inherited |
Allows the insertion of a value for any parameter.
No validity check is performed on the value passed in.
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). |
References _FILEINFO_, Isis::IException::Programmer, and IsisAml::ReturnParam().
|
inherited |
|
protectedinherited |
Returns a pointer to a parameter whose name starts with paramName.
paramName | The name of the parameter to return |
iException::User | (Parameter is not unique) |
iException::User | (Unknown Parameter) |
References _FILEINFO_, IsisAmlData::groups, Isis::IString::UpCase(), and Isis::IException::User.
Referenced by IsisAml::Clear(), IsisAml::CommandLine(), IsisAml::GetAsString(), IsisAml::GetBoolean(), IsisAml::GetCubeName(), IsisAml::GetDouble(), IsisAml::GetFileName(), IsisAml::GetInputAttribute(), IsisAml::GetInteger(), IsisAml::GetOutputAttribute(), IsisAml::GetParams(), IsisAml::GetString(), IsisAml::PutAsString(), IsisAml::PutBoolean(), IsisAml::PutCubeName(), 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.
References IsisAml::CommandLine(), Isis::Preference::Preferences(), IsisAml::ProgramName(), Isis::Pvl::read(), Isis::toInt(), and Isis::PvlObject::Traverse.
Referenced by Isis::Application::Run().
void Isis::UserInterface::SetBatchList | ( | int | i | ) |
Clears the gui parameters and sets the batch list information at line i as the new parameters.
i | The line number to retrieve parameter information from |
Isis::IException::User | - Invalid command line |
References _FILEINFO_, IsisAml::Clear(), IsisAml::NumGroups(), IsisAml::NumParams(), 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.
i | The line of the batchlist to write to the error file |
Isis::IException::User | - Unable to create error list - Disk may be full or directory permissions not writeable |
References _FILEINFO_, and Isis::IException::User.
Referenced by Isis::Application::Run().
|
inherited |
Returns a boolean value based on the QString contents.
value | The value to convert to a boolean |
iException::Programmer | (Invalid boolean value) |
References _FILEINFO_, and Isis::IException::Programmer.
Referenced by Isis::GuiBooleanParameter::Set(), and IsisAml::VerifyAll().
|
inline |
Referenced by Isis::Application::GuiReportError(), and Isis::Application::Run().
|
inherited |
Verify all parameters.
References _FILEINFO_, IsisAml::GetAsString(), IsisAml::GetDouble(), IsisAml::GetInteger(), IsisAml::GetString(), IsisAmlData::groups, IsisParameterData::include, Isis::IException::Programmer, IsisAml::ReturnParam(), IsisAml::StringToBool(), and Isis::IException::User.
Referenced by Isis::Application::Run(), and SetBatchList().
|
inherited |
Returns the application version date.
References IsisAmlData::changes.
Referenced by Isis::Application::History().
|
inherited |
Returns a true if the parameter has a value, and false if it does not.
paramName | The name of the parameter to check if it was entered |
References IsisAml::ReturnParam().
Referenced by Isis::GuiParameter::SetToCurrent(), and Isis::GuiParameter::Update().
|
inherited |
Referenced by IsisAml::Brief(), and IsisXMLApplication::startElement().
|
inherited |
Referenced by IsisXMLApplication::startElement().
|
inherited |
Referenced by IsisXMLApplication::startElement(), and IsisAml::Version().
|
inherited |
Referenced by IsisAml::Description(), and IsisXMLApplication::startElement().
|
inherited |
Referenced by IsisAml::CommandLine(), IsisAml::GetParams(), IsisAml::GroupIndex(), IsisAml::GroupName(), IsisAml::HelperBrief(), IsisAml::HelperButtonName(), IsisAml::HelperDescription(), IsisAml::HelperFunction(), IsisAml::HelperIcon(), IsisAml::HelpersSize(), IsisAml::NumGroups(), IsisAml::NumParams(), IsisAml::ParamBrief(), IsisAml::ParamDefault(), IsisAml::ParamDescription(), IsisAml::ParamExclude(), IsisAml::ParamExcludeSize(), IsisAml::ParamFileMode(), IsisAml::ParamFilter(), 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::ParamListDescription(), 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::ParamPath(), IsisAml::ParamType(), IsisAml::PixelType(), IsisAml::ReturnParam(), IsisXMLApplication::startElement(), and IsisAml::VerifyAll().
|
inherited |