Application program XML file parameter manager. More...

#include <IsisAml.h>

Inheritance diagram for IsisAml:

Collaboration diagram for IsisAml:

Public Member Functions
	IsisAml (const QString &xmlfile)
	Constructs an IsisAml object and internalizes the XML data in the given file name.
	~IsisAml ()
	Destructs an IsisAml object.
void	PutAsString (const QString &paramName, const QString &value)
	Allows the insertion of a value for any parameter.
void	PutAsString (const QString &paramName, const std::vector< QString > &value)
void	PutFileName (const QString &paramName, const QString &value)
	Allows the insertion of a value for a parameter of type "filename".
void	PutFileName (const QString &paramName, const std::vector< QString > &value)
void	PutDouble (const QString &paramName, const double &value)
	Allows the insertion of a value for a parameter of type "double".
void	PutDouble (const QString &paramName, const std::vector< double > &value)
void	PutInteger (const QString &paramName, const int &value)
	Allows the insertion of a value for a parameter of type "integer".
void	PutInteger (const QString &paramName, const std::vector< int > &value)
void	PutBoolean (const QString &paramName, const bool &value)
	Allows the insertion of a value for a parameter of type "boolean".
void	PutBoolean (const QString &paramName, const std::vector< bool > &value)
void	PutString (const QString &paramName, const QString &value)
	Allows the insertion of a value for any parameter.
void	PutString (const QString &paramName, const std::vector< QString > &value)
QString	GetAsString (const QString &paramName) const
	Allows the retrieval of a value for a parameter of any type.
void	GetAsString (const QString &paramName, std::vector< QString > &values) const
QString	GetFileName (const QString &paramName, QString extension="") const
	Allows the retrieval of a value for a parameter of type "filename".
void	GetFileName (const QString &paramName, std::vector< QString > &values) const
QString	GetString (const QString &paramName) const
	Allows the retrieval of a value for a parameter of type "string".
void	GetString (const QString &paramName, std::vector< QString > &values) const
int	GetInteger (const QString &paramName) const
	Allows the retrieval of a value for a parameter of type "integer".
void	GetInteger (const QString &paramName, std::vector< int > &values) const
bool	GetBoolean (const QString &paramName) const
	Allows the retrieval of a value for a parameter of type "boolean".
void	GetBoolean (const QString &paramName, std::vector< bool > &values) const
double	GetDouble (const QString &paramName) const
	Allows the retrieval of a value for a parameter of type "double".
void	GetDouble (const QString &paramName, std::vector< double > &values) const
bool	WasEntered (const QString &paramName) const
	Returns a true if the parameter has a value, and false if it does not.
void	Clear (const QString &paramName)
	Clears the value(s) in the named parameter.
Isis::CubeAttributeInput &	GetInputAttribute (const QString &paramName)
	Gets the attributes for an input cube.
Isis::CubeAttributeOutput &	GetOutputAttribute (const QString &paramName)
	Gets the attributes for an output cube.
QString	ProgramName () const
	Returns the Program name.
QString	Brief () const
	Returns the brief description of the program.
QString	Description () const
	Returns the full description of the program.
int	NumGroups () const
	Returns the number of groups found in the XML.
QString	GroupName (const int &group) const
	Returns the group name of group[index].
int	GroupIndex (const QString &grpName) const
	Given the group name get its index in group array.
int	NumParams (const int &) const
	Returns the number of parameters in a group.
QString	ParamName (const int &group, const int &param) const
	Returns the parameter name.
QString	ParamType (const int &group, const int &param) const
	Returns the parameter type of a parameter in a specified group.
QString	ParamBrief (const int &group, const int &param) const
	Returns the brief description of a parameter in a specified group.
QString	ParamDescription (const int &group, const int &param) const
	Returns the long description of a parameter in a specified group.
QString	ParamMinimum (const int &group, const int &param) const
	Returns the minimum value of a parameter in a specified group.
QString	ParamMinimumInclusive (const int &group, const int &param) const
	Returns whether the minimum value is inclusive or not.
QString	ParamMaximum (const int &group, const int &param) const
	Returns the maximum value of a parameter in a specified group.
QString	ParamMaximumInclusive (const int &group, const int &param) const
	Returns whether the maximum value is inclusive or not.
QString	ParamOdd (const int &group, const int &param) const
	Returns whether the selected parameter has a restriction on odd values or not.
int	ParamGreaterThanSize (const int &group, const int &param) const
	Returns the number of values in the parameters greater than list.
int	ParamGreaterThanOrEqualSize (const int &group, const int &param) const
	Returns the number of values in the parameters greater than or equal list.
int	ParamLessThanSize (const int &group, const int &param) const
	Returns the number of values in the parameters less than list.
int	ParamLessThanOrEqualSize (const int &group, const int &param) const
	Returns the number of values in the parameters less than or equal list.
int	ParamNotEqualSize (const int &group, const int &param) const
	Returns the number of values in the not equal list.
QString	ParamGreaterThan (const int &group, const int &param, const int &great) const
	Returns the name of the specified greaterThan parameter.
QString	ParamGreaterThanOrEqual (const int &group, const int &param, const int &great) const
	Returns the name of the specified greaterThanOrEqual parameter.
QString	ParamLessThan (const int &group, const int &param, const int &great) const
	Returns the name of the specified lessThan parameter.
QString	ParamLessThanOrEqual (const int &group, const int &param, const int &les) const
	Returns the name of the specified lessThanOrEqual parameter.
QString	ParamNotEqual (const int &group, const int &param, const int &notEq) const
	Returns the name of the specified notEqual parameter.
int	ParamListSize (const int &group, const int &param) const
	Returns the number of options in the specified parameter's list.
QString	ParamListValue (const int &group, const int &param, const int &option) const
	Returns the option value for a specific option to a parameter.
QString	ParamListBrief (const int &group, const int &param, const int &option) const
	Returns the brief description for a specific option to a parameter.
QString	ParamListDescription (const int &group, const int &param, const int &option) const
	Returns the full description for a specific option to a parameter.
int	ParamListExcludeSize (const int &group, const int &param, const int &option) const
	Returns the number of items in a parameters list exclude section.
QString	ParamListExclude (const int &group, const int &param, const int &option, const int &exclude) const
	Returns the parameter name to be excluded if this option is selected.
int	ParamListIncludeSize (const int &group, const int &param, const int &option) const
	Returns the number of items in a parameters list include section.
QString	ParamListInclude (const int &group, const int &param, const int &option, const int &include) const
	Returns the parameter name to be included if this option is selected.
QString	ParamDefault (const int &group, const int &param) const
	Returns the default for a parameter in a specified group.
QString	ParamInternalDefault (const int &group, const int &param) const
	Returns the internal default for a parameter in a specified group.
QString	ParamFilter (const int &group, const int &param) const
	Returns the parameter filter for a parameter in a specified group.
QString	ParamPath (const int &group, const int &param) const
	Returns the default path for a filename/cube parameter.
QString	ParamFileMode (const int &group, const int &param) const
	Returns the file mode for a parameter in a specified group.
int	ParamExcludeSize (const int &group, const int &param) const
	Returns the number of parameters excluded in this parameter's exclusions.
QString	ParamExclude (const int &group, const int &param, const int &exclude) const
	Returns the name of the specified excluded parameter.
int	ParamIncludeSize (const int &group, const int &param) const
	Returns the number of parameters included in this parameter's inclusions.
QString	ParamInclude (const int &group, const int &param, const int &include) const
	Returns the name of the specified included parameter.
QString	PixelType (const int &group, const int &param) const
	Returns the default pixel type from the XML.
int	HelpersSize (const int &group, const int &param) const
	Returns the number of helpers the parameter has.
QString	HelperButtonName (const int &group, const int &param, const int &helper) const
	Returns the name of the helper button.
QString	HelperFunction (const int &group, const int &param, const int &helper) const
	Returns the name of the helper function.
QString	HelperBrief (const int &group, const int &param, const int &helper) const
	Returns the brief description of the helper button.
QString	HelperDescription (const int &group, const int &param, const int &helper) const
	Returns the long description of the helper button.
QString	HelperIcon (const int &group, const int &param, const int &helper) const
	Returns the name of the icon for the helper button.
bool	IsParamInPvlInclude (QString &paramName, std::vector< QString > &exclude)
	Verify whether Parameter name is in the Include list Used in creation of DefFile.
void	CreatePVL (Isis::Pvl &pvlDef, QString guiGrpName, QString pvlObjName, QString pvlGrpName, std::vector< QString > &exclude)
	Create Pvl with the parameters in a user defined group given the Pvl object and group name.
void	VerifyAll ()
	Verify all parameters.
bool	StringToBool (QString value) const
	Returns a boolean value based on the QString contents.
void	CommandLine (Isis::Pvl &lab) const
	Creates a QString which could be used as a command line.
QString	Version () const
	Returns the application version date.

Protected Member Functions
const IsisParameterData *	ReturnParam (const QString &paramName) const
	Returns a pointer to a parameter whose name starts with paramName.

Protected Attributes
QString	name
QString	brief
QString	description
std::vector< IsisGroupData >	groups
std::vector< QString >	categorys
std::vector< IsisChangeData >	changes

Private Member Functions
void	StartParser (const char *xmlfile)
	Starts parsing an application xml file.
void	Verify (const IsisParameterData *param)
	Throws an Isis::iExceptionXxxxxxxx if the parameter value(s) is invalid.
void	CheckFileNamePreference (QString filename, QString paramname)
	This method checks whether the user preferences are set to allow overwrites of existing files.

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

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

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

History:: 2010-07-19 Jeannie Walldren - Added check whether user preferences are set to allow file overwrite in Verify() method

History:: 2010-07-21 Sharmila Prasad - Modified for doxygen documentation Warning

History:: 2010-07-22 Steven Lambright - Array values for parameters are now written to the history file

History:: 2011-08-16 Sharmila Prasad - Added API to CreatePVL from a GUI Group and Get GUI Group index given the Group name

History:: 2012-11-20 Janet Barrett - Fixed the GetString method so that it doesn't stop searching for a matched string until an exact match is found or it has gone through the entire list. Fixes #554.

Definition at line 149 of file IsisAml.h.

Constructor & Destructor Documentation

IsisAml::IsisAml ( const QString & xmlfile )

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

Todo:: This namespace needs documentation.

Parameters

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

Definition at line 54 of file IsisAml.cpp.

IsisAml::~IsisAml ( )

Destructs an IsisAml object.

Definition at line 61 of file IsisAml.cpp.

Member Function Documentation

QString IsisAml::Brief ( ) const

Returns the brief description of the program.

Returns: The brief description.

Definition at line 1084 of file IsisAml.cpp.

void IsisAml::CheckFileNamePreference	(	QString	filename,
		QString	paramname
	)

private

This method checks whether the user preferences are set to allow overwrites of existing files.

It should be called if the parameter is an output and the given file name exists.

Parameters

filename	Name of the file to be overwritten.
paramname	Name of the output file parameter.

Exceptions

iException::User	- "The file already exists. The user preference file customization group is set to disallow file overwrites."
iException::User	- "Invalid entry in user preference file FileCustomization group."

Author: 2010-07-19 Jeannie Walldren

History:: 2010-07-19 Jeannie Walldren - Original version.

Definition at line 2383 of file IsisAml.cpp.

References _FILEINFO_, Isis::PvlObject::findGroup(), Isis::PvlContainer::findKeyword(), and Isis::IException::User.

void IsisAml::Clear ( const QString & paramName )

Clears the value(s) in the named parameter.

Parameters

paramName The name of the parameter to clear

Definition at line 1868 of file IsisAml.cpp.

References Isis::CubeAttribute< ChildClass >::setAttributes().

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

Parameters

cont	Pvl to put command line information in

Definition at line 2926 of file IsisAml.cpp.

References Isis::PvlObject::addGroup(), Isis::PvlKeyword::addValue(), Isis::PvlObject::clear(), Isis::PvlContainer::deleteKeyword(), Isis::PvlContainer::hasKeyword(), Isis::IString::Trim(), and Isis::IString::UpCase().

Referenced by Isis::UserInterface::SaveHistory().

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

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.

Author: Sharmila Prasad (8/11/2011)

Parameters

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

Definition at line 1150 of file IsisAml.cpp.

References _FILEINFO_, Isis::IString::DownCase(), Isis::toString(), and Isis::IException::User.

QString IsisAml::Description ( ) const

Returns the full description of the program.

Returns: The full description.

Definition at line 1094 of file IsisAml.cpp.

QString IsisAml::GetAsString ( const QString & paramName ) const

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

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

Parameters

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

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

Exceptions

iException (IsisProgrammerError) The parameter has no value.

Definition at line 553 of file IsisAml.cpp.

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

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

bool IsisAml::GetBoolean ( const QString & 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 989 of file IsisAml.cpp.

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

double IsisAml::GetDouble ( const QString & 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 907 of file IsisAml.cpp.

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

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

QString IsisAml::GetFileName	(	const QString &	paramName,
		QString	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 623 of file IsisAml.cpp.

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

Referenced by Isis::Pipeline::SetInputFile(), Isis::Pipeline::SetInputListFile(), and Isis::Pipeline::SetOutputListFile().

Isis::CubeAttributeInput & IsisAml::GetInputAttribute ( const QString & 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 in not an input cube"

Definition at line 1890 of file IsisAml.cpp.

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

Referenced by Isis::Pipeline::SetInputFile().

int IsisAml::GetInteger ( const QString & 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 823 of file IsisAml.cpp.

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

Referenced by Isis::ProcessByQuickFilter::GetFilterParameters().

Isis::CubeAttributeOutput & IsisAml::GetOutputAttribute ( const QString & 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 in not an output"

Definition at line 1935 of file IsisAml.cpp.

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

Referenced by Isis::ProcessImport::SetOutputCube().

QString IsisAml::GetString ( const QString & 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 708 of file IsisAml.cpp.

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

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

int IsisAml::GroupIndex ( const QString & grpName ) const

Given the group name get its index in group array.

Given group name return its index in the Gui.

Author: Sharmila Prasad (8/11/2011)

Parameters

grpName

Returns: int

Definition at line 1128 of file IsisAml.cpp.

References Isis::IString::DownCase().

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

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

Definition at line 1812 of file IsisAml.cpp.

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

QString IsisAml::HelperButtonName	(	const int &	group,
		const int &	param,
		const int &	helper
	)		const

Returns the name of the helper button.

Parameters

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

Returns: QString The name of the helper

Definition at line 1784 of file IsisAml.cpp.

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

QString IsisAml::HelperDescription	(	const int &	group,
		const int &	param,
		const int &	helper
	)		const

Returns the long description of the helper button.

Parameters

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

Returns: QString The long description of the helper button

Definition at line 1826 of file IsisAml.cpp.

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

QString IsisAml::HelperFunction	(	const int &	group,
		const int &	param,
		const int &	helper
	)		const

Returns the name of the helper function.

Parameters

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

Returns: QString The name of the helper function

Definition at line 1798 of file IsisAml.cpp.

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

QString IsisAml::HelperIcon	(	const int &	group,
		const int &	param,
		const int &	helper
	)		const

Returns the name of the icon for the helper button.

Parameters

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

Returns: QString The name of the helper icon

Definition at line 1840 of file IsisAml.cpp.

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

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

Returns the number of helpers the parameter has.

Parameters

group	The group index
param	The parameter index

Returns: int The number of helpers the parameter has

Definition at line 1771 of file IsisAml.cpp.

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

bool IsisAml::IsParamInPvlInclude	(	QString &	paramName,
		std::vector< QString > &	exclude
	)

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

Verify if the Parameter is in the Included list.

Author: Sharmila Prasad (8/11/2011)

Parameters

paramName	- parameter name
include	- include list

Returns: bool

Definition at line 1207 of file IsisAml.cpp.

References Isis::IString::DownCase().

int IsisAml::NumGroups ( ) const

Returns the number of groups found in the XML.

Returns: The number of groups.

Definition at line 1103 of file IsisAml.cpp.

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

Referenced by Isis::UserInterface::evaluateOption(), Isis::Gui::Gui(), and Isis::UserInterface::SetBatchList().

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

Referenced by Isis::UserInterface::evaluateOption(), and Isis::GuiParameter::GuiParameter().

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

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

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

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

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

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

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

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

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

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

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

Referenced by Isis::UserInterface::evaluateOption(), and Isis::GuiParameter::GuiParameter().

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

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

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

Referenced by Isis::UserInterface::evaluateOption(), and Isis::GuiParameter::GuiParameter().

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

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

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

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

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

QString IsisAml::ParamLessThan	(	const int &	group,
		const int &	param,
		const int &	les
	)		const

Returns the name of the specified lessThan parameter.

Parameters

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

Returns: The name of the lessThan parameter

Definition at line 1433 of file IsisAml.cpp.

Referenced by Isis::UserInterface::evaluateOption(), and Isis::GuiParameter::GuiParameter().

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

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

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

Referenced by Isis::UserInterface::evaluateOption(), and Isis::GuiParameter::GuiParameter().

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

Referenced by Isis::UserInterface::evaluateOption().

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

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

Referenced by Isis::UserInterface::evaluateOption(), Isis::GuiComboBoxParameter::Exclusions(), 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 1676 of file IsisAml.cpp.

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

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

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

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

Referenced by Isis::UserInterface::evaluateOption().

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

Referenced by Isis::UserInterface::evaluateOption().

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

Referenced by Isis::UserInterface::evaluateOption(), and Isis::GuiParameter::GuiParameter().

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

Referenced by Isis::UserInterface::evaluateOption(), and Isis::GuiParameter::GuiParameter().

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

Referenced by Isis::UserInterface::evaluateOption(), and Isis::GuiParameter::GuiParameter().

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

Referenced by Isis::UserInterface::evaluateOption(), and Isis::GuiParameter::GuiParameter().

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

Referenced by Isis::UserInterface::evaluateOption(), Isis::GuiParameter::GuiParameter(), Isis::GuiCubeParameter::SelectAttribute(), and Isis::UserInterface::SetBatchList().

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

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

Referenced by Isis::UserInterface::evaluateOption(), and Isis::GuiParameter::GuiParameter().

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

Referenced by Isis::UserInterface::evaluateOption(), and Isis::GuiParameter::GuiParameter().

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

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

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

Referenced by Isis::UserInterface::evaluateOption(), and Isis::GuiParameter::GuiParameter().

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

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

QString IsisAml::ProgramName ( ) const

Returns the Program name.

Returns: The name of the program.

Definition at line 1073 of file IsisAml.cpp.

Referenced by Isis::UserInterface::evaluateOption(), Isis::UserInterface::loadHistory(), Isis::UserInterface::SaveHistory(), Isis::Gui::ShowWarning(), Isis::Gui::StopProcessing(), Isis::Gui::UpdateCommandLine(), and Isis::Gui::UpdateHistory().

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

Exceptions

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

Definition at line 81 of file IsisAml.cpp.

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

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 QString &	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 462 of file IsisAml.cpp.

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

void IsisAml::PutDouble	(	const QString &	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 377 of file IsisAml.cpp.

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

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

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

Definition at line 211 of file IsisAml.cpp.

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

void IsisAml::PutInteger	(	const QString &	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 291 of file IsisAml.cpp.

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

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

Definition at line 144 of file IsisAml.cpp.

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

const IsisParameterData * IsisAml::ReturnParam ( const QString & paramName ) const

protected

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

Parameters

paramName The name of the parameter to return

Returns: IsisParameterData

Exceptions

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

Definition at line 1981 of file IsisAml.cpp.

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

Referenced by Isis::UserInterface::loadHistory().

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

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

bool IsisAml::StringToBool ( QString value ) const

Returns a boolean value based on the QString contents.

Parameters

value The value to convert to a boolean

Returns: boolean value based on QString contents

Exceptions

iException::Programmer (Invalid boolean value)

Definition at line 2883 of file IsisAml.cpp.

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

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

History:: 2010-07-19 Jeannie Walldren - Added check for FileCustomization preference if an existing output file is selected

Definition at line 2033 of file IsisAml.cpp.

References _FILEINFO_, Isis::IException::Programmer, Isis::IString::ToDouble(), Isis::toInt(), Isis::IString::ToInteger(), Isis::IString::UpCase(), and Isis::IException::User.

void IsisAml::VerifyAll ( )

Verify all parameters.

Definition at line 2403 of file IsisAml.cpp.

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

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

QString IsisAml::Version ( ) const

Returns the application version date.

Returns: The application version date

Definition at line 3003 of file IsisAml.cpp.

bool IsisAml::WasEntered ( const QString & 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 1852 of file IsisAml.cpp.

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 353 of file IsisAml.h.

XERCES::SAX2XMLReader* IsisAml::parser

private

The XML file parser.

Definition at line 351 of file IsisAml.h.

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

src/base/objs/IsisAml/IsisAml.h
src/base/objs/IsisAml/IsisAml.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation