USGS

Isis 3.0 Object Programmers' Reference

 Home

IsisAml Class Reference
[Application Interface]

#include <IsisAml.h>

Inheritance diagram for IsisAml:

Inheritance graph
[legend]
Collaboration diagram for IsisAml:

Collaboration graph
[legend]
List of all members.

Detailed Description

Application program XML file parameter manager.

This class is used to manage the data in an application XML file pertaining to the program parameters. The data is stored, accessed, and modified through this class and its helper classes.

Author:
2002-05-30 Stuart Sides

For internal use only.

Todo:
This class needs an example.
History:
2002-10-31 Stuart Sides - Added check to make sure all parameters have some type of value or are excluded by some other parameter.
History:
2002-11-05 Stuart Sides - Modified GetString member to return the matching list member (if a list exists) instead of the value itself.
History:
2002-12-10 Stuart Sides - modified GetFilename member to return the filename(s) with environment variables expanded.
History:
2003-01-24 Stuart Sides - took out schema checking for the time being. It will need to be put back in after the user preferences object is finished.
History:
2003-01-27 Stuart Sides - modified GetFilename.
History:
2003-02-07 Stuart Sides - fixed VerifyAll to better check list/option/includes,excludes
History:
2003-02-13 Stuart Sides - allowed list/option/included parameters to use the default value instead of just the value.
History:
2003-02-20 Stuart Sides - fixed problem where excludes/includes were throwing an error when they should not have.
History:
2003-03-12 Stuart Sides - added member to construct a command line from the internalized data and return it as a string (CommandLine).
History:
2003-03-12 Stuart Sides - added member to construct a command line from the internalized data and return it as a string (CommandLine).
History:
2003-03-13 Stuart Sides - modified member CommandLine to take a Label reference instead of returning a Label.
History:
2003-03-13 Stuart Sides - socumented new member CommandLine.
History:
2003-04-03 Stuart Sides - fixed bug where integer parameters that need to be odd were not being checked.
History:
2003-05-16 Stuart Sides - modified schema from astrogeology... isis.astrogeology...
History:
2003-05-30 Stuart Sides - fixed uninitialized variable compiler error when -O1 flag was added.
History:
2003-06-04 Stuart Sides - fixed a problem where the GetString member was not returning the full list option value.
History:
2003-06-05 Stuart Sides - added the member "Version" to the class. It will return the date of the most recent change to the application. This involved parsing the history/change entries, which was being ignored previously.
History:
2003-07-02 Stuart Sides - added the new parameter type "cube"
History:
2003-07-03 Stuart Sides - added the members "Brief and Description" to return the application brief and full description.
History:
2003-08-01 Stuart Sides - made get and put Filename work for cubes too.
History:
2003-08-26 Jeff Anderson - added extension option to GetFilename method.
History:
2003-08-27 Stuart Sides - fixed bug where not all parameters would get internalized if there where html tags inside a description of a parameter
History:
2003-12-03 Jeff Anderson - modified CommandLine method to output all parameters except those in option list excludes.
History:
2004-01-21 Stuart Sides - added members for accessing a parameters exclude(s).
History:
2004-02-26 Stuart Sides - added parsing and get members for the default path in the XML
History:
2004-03-03 Stuart Sides - added member function PixelType so IsisGui can get the pixel type of a cube
History:
2004-09-01 Stuart Sides - modified so the parameter names don't get capitalized as they are read from the applications xml file. This caused other modifications to the ReturnParam member, so it would find the requested parameter in a case insensitive way.
History:
2005-10-03 Elizabeth Miller - changed
History:
2005-12-13 Stuart Sides - Took out an "exit(1)" in the GetString method. Couldn't find a reason for it to be there.
History:
2005-12-28 Elizabeth Miller - Added extra methods and private vars to retrieve info needed for gui and command line help
History:
2006-02-13 Elizabeth Miller - Added GuiHelper Capabilities
History:
2006-10-17 Steven Lambright - Fixed problem with boolean inclusion/exclusion

Definition at line 132 of file IsisAml.h.

Public Member Functions

 IsisAml (const std::string &xmlfile)
 Constructs an IsisAml object and internalizes the XML data in the given file name.
 ~IsisAml ()
 Destructs an IsisAml object.
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 StartParser (const char *xmlfile)
 Starts parsing an application xml file.
const IsisParameterData * ReturnParam (const std::string &paramName) const
 Returns a pointer to a parameter whos name starts with paramName.
void Verify (const IsisParameterData *param)
 Throws an Isis::iExceptionXxxxxxxx if the parameter value(s) is invalid.

Private Attributes

XERCES::SAX2XMLReader * parser
 The XML file parser.
IsisXMLApplication * appHandler
 The application handler.

Constructor & Destructor Documentation

IsisAml::IsisAml ( const std::string &  xmlfile  ) 

Constructs an IsisAml object and internalizes the XML data in the given file name.

Parameters:
xmlfile Indicates the pull path of the XML file to be parsed.

Definition at line 48 of file IsisAml.cpp.

References StartParser().

IsisAml::~IsisAml (  ) 

Destructs an IsisAml object.

Definition at line 55 of file IsisAml.cpp.

Member Function Documentation

string IsisAml::Brief (  )  const

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  ) 

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(), ReturnParam(), Isis::CubeAttributeOutput::Set(), and IsisParameterData::values.

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

void IsisAml::CommandLine ( Isis::Pvl &  cont  )  const

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, GetAsString(), IsisAmlData::groups, Isis::PvlContainer::HasKeyword(), ParamName(), ReturnParam(), and value.

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

string IsisAml::Description (  )  const

Returns the full description of the program.

Returns:
The full description.

Definition at line 1084 of file IsisAml.cpp.

References IsisAmlData::description.

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

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(), ReturnParam(), value, and IsisParameterData::values.

string IsisAml::GetAsString ( const std::string &  paramName  )  const

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(), ReturnParam(), value, and IsisParameterData::values.

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

void IsisAml::GetBoolean ( const std::string &  paramName,
std::vector< bool > &  values 
) const

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(), ReturnParam(), StringToBool(), IsisParameterData::type, Isis::iString::UpCase(), value, and IsisParameterData::values.

bool IsisAml::GetBoolean ( const std::string &  paramName  )  const

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(), ReturnParam(), StringToBool(), IsisParameterData::type, value, and IsisParameterData::values.

void IsisAml::GetDouble ( const std::string &  paramName,
std::vector< double > &  values 
) const

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(), ReturnParam(), IsisParameterData::type, value, and IsisParameterData::values.

double IsisAml::GetDouble ( const std::string &  paramName  )  const

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(), ReturnParam(), IsisParameterData::type, value, and IsisParameterData::values.

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

void IsisAml::GetFilename ( const std::string &  paramName,
std::vector< std::string > &  values 
) const

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, ReturnParam(), IsisParameterData::type, and IsisParameterData::values.

string IsisAml::GetFilename ( const std::string &  paramName,
std::string  extension = "" 
) const

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

Isis::CubeAttributeInput & IsisAml::GetInputAttribute ( const std::string &  paramName  ) 

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

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(), ReturnParam(), IsisParameterData::type, value, and IsisParameterData::values.

int IsisAml::GetInteger ( const std::string &  paramName  )  const

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(), ReturnParam(), IsisParameterData::type, value, and IsisParameterData::values.

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

Isis::CubeAttributeOutput & IsisAml::GetOutputAttribute ( const std::string &  paramName  ) 

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

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(), ReturnParam(), IsisParameterData::type, value, and IsisParameterData::values.

string IsisAml::GetString ( const std::string &  paramName  )  const

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(), ReturnParam(), IsisParameterData::type, value, and IsisParameterData::values.

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

string IsisAml::GroupName ( const int &  index  )  const

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

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

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

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

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

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

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

int IsisAml::NumGroups (  )  const

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 Isis::UserInterface::EvaluateOption(), Isis::Gui::Gui(), and Isis::UserInterface::SetBatchList().

int IsisAml::NumParams ( const int &  group  )  const

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 Isis::UserInterface::EvaluateOption(), Isis::Gui::Gui(), and Isis::UserInterface::SetBatchList().

string IsisAml::ParamBrief ( const int &  group,
const int &  param 
) const

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 Isis::UserInterface::EvaluateOption(), Isis::GuiBooleanParameter::GuiBooleanParameter(), and Isis::GuiParameter::GuiParameter().

string IsisAml::ParamDefault ( const int &  group,
const int &  param 
) const

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 Isis::UserInterface::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

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

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 Isis::UserInterface::EvaluateOption(), Isis::GuiBooleanParameter::Exclusions(), and Isis::GuiParameter::GuiParameter().

int IsisAml::ParamExcludeSize ( const int &  group,
const int &  param 
) const

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 Isis::UserInterface::EvaluateOption(), Isis::GuiBooleanParameter::Exclusions(), and Isis::GuiParameter::GuiParameter().

string IsisAml::ParamFileMode ( const int &  group,
const int &  param 
) const

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

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

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 Isis::UserInterface::EvaluateOption(), and Isis::GuiParameter::GuiParameter().

string IsisAml::ParamGreaterThanOrEqual ( const int &  group,
const int &  param,
const int &  great 
) const

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 Isis::UserInterface::EvaluateOption(), and Isis::GuiParameter::GuiParameter().

int IsisAml::ParamGreaterThanOrEqualSize ( const int &  group,
const int &  param 
) const

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 Isis::UserInterface::EvaluateOption(), and Isis::GuiParameter::GuiParameter().

int IsisAml::ParamGreaterThanSize ( const int &  group,
const int &  param 
) const

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 Isis::UserInterface::EvaluateOption(), and Isis::GuiParameter::GuiParameter().

string IsisAml::ParamInclude ( const int &  group,
const int &  param,
const int &  include 
) const

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 Isis::UserInterface::EvaluateOption(), Isis::GuiBooleanParameter::Exclusions(), and Isis::GuiParameter::GuiParameter().

int IsisAml::ParamIncludeSize ( const int &  group,
const int &  param 
) const

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 Isis::UserInterface::EvaluateOption(), Isis::GuiBooleanParameter::Exclusions(), and Isis::GuiParameter::GuiParameter().

string IsisAml::ParamInternalDefault ( const int &  group,
const int &  param 
) const

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 Isis::UserInterface::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

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 Isis::UserInterface::EvaluateOption(), and Isis::GuiParameter::GuiParameter().

string IsisAml::ParamLessThanOrEqual ( const int &  group,
const int &  param,
const int &  les 
) const

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 Isis::UserInterface::EvaluateOption(), and Isis::GuiParameter::GuiParameter().

int IsisAml::ParamLessThanOrEqualSize ( const int &  group,
const int &  param 
) const

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 Isis::UserInterface::EvaluateOption(), and Isis::GuiParameter::GuiParameter().

int IsisAml::ParamLessThanSize ( const int &  group,
const int &  param 
) const

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 Isis::UserInterface::EvaluateOption(), and Isis::GuiParameter::GuiParameter().

string IsisAml::ParamListBrief ( const int &  group,
const int &  param,
const int &  option 
) const

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 Isis::UserInterface::EvaluateOption(), and Isis::GuiListParameter::GuiListParameter().

string IsisAml::ParamListDescription ( const int &  group,
const int &  param,
const int &  option 
) const

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

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 Isis::UserInterface::EvaluateOption(), and Isis::GuiListParameter::Exclusions().

int IsisAml::ParamListExcludeSize ( const int &  group,
const int &  param,
const int &  option 
) const

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 Isis::UserInterface::EvaluateOption(), and Isis::GuiListParameter::Exclusions().

string IsisAml::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.

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 Isis::UserInterface::EvaluateOption().

int IsisAml::ParamListIncludeSize ( const int &  group,
const int &  param,
const int &  option 
) const

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 Isis::UserInterface::EvaluateOption().

int IsisAml::ParamListSize ( const int &  group,
const int &  param 
) const

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(), Isis::UserInterface::EvaluateOption(), Isis::GuiListParameter::GuiListParameter(), and Isis::GuiListParameter::Set().

string IsisAml::ParamListValue ( const int &  group,
const int &  param,
const int &  option 
) const

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 Isis::UserInterface::EvaluateOption(), Isis::GuiListParameter::GuiListParameter(), Isis::GuiListParameter::Set(), and Isis::GuiListParameter::Value().

string IsisAml::ParamMaximum ( const int &  group,
const int &  param 
) const

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 Isis::UserInterface::EvaluateOption(), and Isis::GuiParameter::GuiParameter().

string IsisAml::ParamMaximumInclusive ( const int &  group,
const int &  param 
) const

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 Isis::UserInterface::EvaluateOption(), and Isis::GuiParameter::GuiParameter().

string IsisAml::ParamMinimum ( const int &  group,
const int &  param 
) const

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 Isis::UserInterface::EvaluateOption(), and Isis::GuiParameter::GuiParameter().

string IsisAml::ParamMinimumInclusive ( const int &  group,
const int &  param 
) const

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 Isis::UserInterface::EvaluateOption(), and Isis::GuiParameter::GuiParameter().

string IsisAml::ParamName ( const int &  group,
const int &  param 
) const

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 CommandLine(), Isis::UserInterface::EvaluateOption(), Isis::GuiParameter::GuiParameter(), Isis::GuiCubeParameter::SelectAttribute(), and Isis::UserInterface::SetBatchList().

string IsisAml::ParamNotEqual ( const int &  group,
const int &  param,
const int &  notEq 
) const

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 Isis::UserInterface::EvaluateOption(), and Isis::GuiParameter::GuiParameter().

int IsisAml::ParamNotEqualSize ( const int &  group,
const int &  param 
) const

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 Isis::UserInterface::EvaluateOption(), and Isis::GuiParameter::GuiParameter().

string IsisAml::ParamOdd ( const int &  group,
const int &  param 
) const

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 Isis::UserInterface::EvaluateOption(), and Isis::GuiParameter::GuiParameter().

string IsisAml::ParamPath ( const int &  group,
const int &  param 
) const

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

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(), Isis::UserInterface::EvaluateOption(), and Isis::GuiParameter::GuiParameter().

string IsisAml::PixelType ( const int &  group,
const int &  param 
) const

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 Isis::UserInterface::EvaluateOption(), Isis::GuiParameter::GuiParameter(), and Isis::GuiCubeParameter::SelectAttribute().

string IsisAml::ProgramName (  )  const

Returns the Program name.

Returns:
The name of the program.

Definition at line 1063 of file IsisAml.cpp.

References IsisAmlData::name.

Referenced by Isis::UserInterface::EvaluateOption(), Isis::Application::History(), Isis::UserInterface::LoadHistory(), Isis::UserInterface::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 
)

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(), ReturnParam(), and IsisParameterData::values.

void IsisAml::PutAsString ( const std::string &  paramName,
const std::string &  value 
)

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(), ReturnParam(), and IsisParameterData::values.

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

void IsisAml::PutBoolean ( const std::string &  paramName,
const std::vector< bool > &  value 
)

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(), ReturnParam(), IsisParameterData::type, IsisParameterData::values, and Verify().

void IsisAml::PutBoolean ( const std::string &  paramName,
const bool &  value 
)

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(), ReturnParam(), IsisParameterData::type, IsisParameterData::values, and Verify().

void IsisAml::PutDouble ( const std::string &  paramName,
const std::vector< double > &  value 
)

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(), ReturnParam(), IsisParameterData::type, IsisParameterData::values, and Verify().

void IsisAml::PutDouble ( const std::string &  paramName,
const double &  value 
)

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(), ReturnParam(), IsisParameterData::type, IsisParameterData::values, and Verify().

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

void IsisAml::PutFilename ( const std::string &  paramName,
const std::vector< std::string > &  value 
)

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(), ReturnParam(), IsisParameterData::type, IsisParameterData::values, and Verify().

void IsisAml::PutFilename ( const std::string &  paramName,
const std::string &  value 
)

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(), ReturnParam(), IsisParameterData::type, IsisParameterData::values, and Verify().

void IsisAml::PutInteger ( const std::string &  paramName,
const std::vector< int > &  value 
)

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(), ReturnParam(), IsisParameterData::type, IsisParameterData::values, and Verify().

void IsisAml::PutInteger ( const std::string &  paramName,
const int &  value 
)

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(), ReturnParam(), IsisParameterData::type, IsisParameterData::values, and Verify().

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

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(), ReturnParam(), IsisParameterData::type, IsisParameterData::values, and Verify().

void IsisAml::PutString ( const std::string &  paramName,
const std::string &  value 
)

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(), ReturnParam(), IsisParameterData::type, IsisParameterData::values, and Verify().

const IsisParameterData * IsisAml::ReturnParam ( const std::string &  paramName  )  const [private]

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

Parameters:
paramName The name of the parameter to return
Returns:
IsisParameterData
Exceptions:
iException::User (Parameter is not unique)
iException::User (Unknown Parameter)

Definition at line 1873 of file IsisAml.cpp.

References _FILEINFO_, g, IsisAmlData::groups, Isis::iException::Message(), IsisAmlData::name, and Isis::iString::UpCase().

Referenced by Clear(), CommandLine(), GetAsString(), GetBoolean(), GetDouble(), GetFilename(), GetInputAttribute(), GetInteger(), GetOutputAttribute(), GetString(), PutAsString(), PutBoolean(), PutDouble(), PutFilename(), PutInteger(), PutString(), VerifyAll(), and WasEntered().

void IsisAml::StartParser ( const char *  xmlfile  )  [private]

Starts parsing an application xml file.

Parameters:
xmlfile The xml file to parse
Exceptions:
iException::Programmer (Error during XML parser initialization)

Definition at line 2835 of file IsisAml.cpp.

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

Referenced by IsisAml().

bool IsisAml::StringToBool ( Isis::iString  value  )  const

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 GetBoolean(), Isis::GuiBooleanParameter::Set(), Verify(), and VerifyAll().

void IsisAml::Verify ( const IsisParameterData *  param  )  [private]

Throws an Isis::iExceptionXxxxxxxx if the parameter value(s) is invalid.

Parameters:
param The parameter data
Exceptions:
iException::User 

Definition at line 1922 of file IsisAml.cpp.

References _FILEINFO_, IsisParameterData::defaultValues, Isis::iString::DownCase(), e, IsisParameterData::listOptions, IsisParameterData::maximum, IsisParameterData::maximum_inclusive, Isis::iException::Message(), IsisParameterData::minimum, IsisParameterData::minimum_inclusive, IsisParameterData::name, IsisParameterData::odd, StringToBool(), IsisParameterData::type, Isis::iString::UpCase(), value, and IsisParameterData::values.

Referenced by PutBoolean(), PutDouble(), PutFilename(), PutInteger(), PutString(), and VerifyAll().

void IsisAml::VerifyAll (  ) 

Verify all parameters.

Definition at line 2233 of file IsisAml.cpp.

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

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

string IsisAml::Version (  )  const

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

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 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

IsisXMLApplication* IsisAml::appHandler [private]

The application handler.

Definition at line 323 of file IsisAml.h.

Referenced by StartParser().

XERCES::SAX2XMLReader* IsisAml::parser [private]

The XML file parser.

Definition at line 321 of file IsisAml.h.

Referenced by StartParser().

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