|
Isis Developer Reference
|
Go to the documentation of this file.
16 #include <xercesc/sax2/SAX2XMLReader.hpp>
143 IsisAml(
const QString &xmlfile);
151 void PutAsString(
const QString ¶mName,
const QString &value);
152 void PutAsString(
const QString ¶mName,
const std::vector<QString> &value);
154 void PutFileName(
const QString ¶mName,
const QString &value);
155 void PutFileName(
const QString ¶mName,
const std::vector<QString> &value);
157 void PutDouble(
const QString ¶mName,
const double &value);
158 void PutDouble(
const QString ¶mName,
const std::vector<double> &value);
160 void PutInteger(
const QString ¶mName,
const int &value);
161 void PutInteger(
const QString ¶mName,
const std::vector<int> &value);
163 void PutBoolean(
const QString ¶mName,
const bool &value);
164 void PutBoolean(
const QString ¶mName,
const std::vector<bool> &value);
166 void PutString(
const QString ¶mName,
const QString &value);
167 void PutString(
const QString ¶mName,
const std::vector<QString> &value);
169 QString
GetAsString(
const QString ¶mName)
const;
170 void GetAsString(
const QString ¶mName, std::vector<QString> &values)
const;
172 QString
GetFileName(
const QString ¶mName, QString extension =
"")
const;
173 void GetFileName(
const QString ¶mName, std::vector<QString> &values)
const;
175 QString
GetString(
const QString ¶mName)
const;
176 void GetString(
const QString ¶mName, std::vector<QString> &values)
const;
178 int GetInteger(
const QString ¶mName)
const;
179 void GetInteger(
const QString ¶mName, std::vector<int> &values)
const;
181 bool GetBoolean(
const QString ¶mName)
const;
183 void GetBoolean(
const QString ¶mName, std::vector<bool> &values)
const;
185 double GetDouble(
const QString ¶mName)
const;
186 void GetDouble(
const QString ¶mName, std::vector<double> &values)
const;
188 bool WasEntered(
const QString ¶mName)
const;
189 void Clear(
const QString ¶mName);
197 QString
Brief()
const;
205 QString
GroupName(
const int &group)
const;
208 int GroupIndex(
const QString & grpName)
const;
212 QString
ParamName(
const int &group,
const int ¶m)
const;
214 QString
ParamType(
const int &group,
const int ¶m)
const;
216 QString
ParamBrief(
const int &group,
const int ¶m)
const;
220 QString
ParamMinimum(
const int &group,
const int ¶m)
const;
224 QString
ParamMaximum(
const int &group,
const int ¶m)
const;
228 QString
ParamOdd(
const int &group,
const int ¶m)
const;
241 const int &great)
const;
244 const int &great)
const;
247 const int &great)
const;
250 const int &les)
const;
253 const int ¬Eq)
const;
258 const int &option)
const;
261 const int &option)
const;
264 const int &option)
const;
267 const int &option)
const;
270 const int &option,
const int &exclude)
const;
273 const int &option)
const;
276 const int &option,
const int &include)
const;
278 QString
ParamDefault(
const int &group,
const int ¶m)
const;
282 QString
ParamFilter(
const int &group,
const int ¶m)
const;
284 QString
ParamPath(
const int &group,
const int ¶m)
const;
286 QString
ParamFileMode(
const int &group,
const int ¶m)
const;
290 QString
ParamExclude(
const int &group,
const int ¶m,
291 const int &exclude)
const;
294 QString
ParamInclude(
const int &group,
const int ¶m,
295 const int &include)
const;
297 QString
PixelType(
const int &group,
const int ¶m)
const;
299 int HelpersSize(
const int &group,
const int ¶m)
const;
302 const int &helper)
const;
305 const int &helper)
const;
307 QString
HelperBrief(
const int &group,
const int ¶m,
308 const int &helper)
const;
311 const int &helper)
const;
313 QString
HelperIcon(
const int &group,
const int ¶m,
314 const int &helper)
const;
322 QString pvlGrpName, std::vector<QString> & exclude);
340 XERCES::SAX2XMLReader *parser;
345 void StartParser(
const char *xmlfile);
350 void CheckFileNamePreference(QString filename, QString paramname);
void clear()
Remove everything from the current PvlObject.
Definition: PvlObject.h:341
QString HelperIcon(const int &group, const int ¶m, const int &helper) const
Returns the name of the icon for the helper button.
Definition: IsisAml.cpp:1824
Isis::CubeAttributeOutput & GetOutputAttribute(const QString ¶mName)
Gets the attributes for an output cube.
Definition: IsisAml.cpp:1919
void PutBoolean(const QString ¶mName, const std::vector< bool > &value)
double ToDouble() const
Returns the floating point value the IString represents.
Definition: IString.cpp:799
This is free and unencumbered software released into the public domain.
Definition: IsisXMLApplication.h:19
void PutAsString(const QString ¶mName, const QString &value)
Allows the insertion of a value for any parameter.
Definition: IsisAml.cpp:65
void PutFileName(const QString ¶mName, const QString &value)
Allows the insertion of a value for a parameter of type "filename".
Definition: IsisAml.cpp:195
int ParamListSize(const int &group, const int ¶m) const
Returns the number of options in the specified parameter's list.
Definition: IsisAml.cpp:1601
PvlGroupIterator findGroup(const QString &name, PvlGroupIterator beg, PvlGroupIterator end)
Find a group with the specified name, within these indexes.
Definition: PvlObject.h:129
QString HelperDescription(const int &group, const int ¶m, const int &helper) const
Returns the long description of the helper button.
Definition: IsisAml.cpp:1810
Contains Pvl Groups and Pvl Objects.
Definition: PvlObject.h:61
IString DownCase()
Converts all upper case letters in the object IString into lower case characters.
Definition: IString.cpp:644
std::vector< IsisListOptionData > listOptions
Definition: IsisAmlData.h:63
QString GetAsString(const QString ¶mName) const
Allows the retrieval of a value for a parameter of any type.
Definition: IsisAml.cpp:537
A single keyword-value pair.
Definition: PvlKeyword.h:82
QString ParamListValue(const int &group, const int ¶m, const int &option) const
Returns the option value for a specific option to a parameter.
Definition: IsisAml.cpp:1615
int NumGroups() const
Returns the number of groups found in the XML.
Definition: IsisAml.cpp:1087
QString ParamMinimumInclusive(const int &group, const int ¶m) const
Returns whether the minimum value is inclusive or not.
Definition: IsisAml.cpp:1284
void GetFileName(const QString ¶mName, std::vector< QString > &values) const
File name manipulation and expansion.
Definition: FileName.h:100
void PutDouble(const QString ¶mName, const std::vector< double > &value)
void addValue(QString value, QString unit="")
Adds a value with units.
Definition: PvlKeyword.cpp:252
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.
Definition: IsisAml.cpp:1134
void PutString(const QString ¶mName, const std::vector< QString > &value)
IString Trim(const std::string &chars)
Removes characters from the beginning and end of the IString.
Definition: IString.cpp:525
QString ParamBrief(const int &group, const int ¶m) const
Returns the brief description of a parameter in a specified group.
Definition: IsisAml.cpp:1232
QString ParamGreaterThanOrEqual(const int &group, const int ¶m, const int &great) const
Returns the name of the specified greaterThanOrEqual parameter.
Definition: IsisAml.cpp:1402
int HelpersSize(const int &group, const int ¶m) const
Returns the number of helpers the parameter has.
Definition: IsisAml.cpp:1755
QString GetFileName(const QString ¶mName, QString extension="") const
Allows the retrieval of a value for a parameter of type "filename".
Definition: IsisAml.cpp:607
Definition: IsisAmlData.h:53
std::vector< QString > include
Definition: IsisAmlData.h:74
QString maximum
Definition: IsisAmlData.h:67
void GetBoolean(const QString ¶mName, std::vector< bool > &values) const
double GetDouble(const QString ¶mName) const
Allows the retrieval of a value for a parameter of type "double".
Definition: IsisAml.cpp:891
void PutString(const QString ¶mName, const QString &value)
Allows the insertion of a value for any parameter.
Definition: IsisAml.cpp:128
bool hasKeyword(const QString &name) const
Check to see if a keyword exists.
Definition: PvlContainer.cpp:159
QString ParamMaximum(const int &group, const int ¶m) const
Returns the maximum value of a parameter in a specified group.
Definition: IsisAml.cpp:1271
Container for cube-like labels.
Definition: Pvl.h:119
Manipulate and parse attributes of output cube filenames.
Definition: CubeAttribute.h:473
QString HelperFunction(const int &group, const int ¶m, const int &helper) const
Returns the name of the helper function.
Definition: IsisAml.cpp:1782
void PutBoolean(const QString ¶mName, const bool &value)
Allows the insertion of a value for a parameter of type "boolean".
Definition: IsisAml.cpp:446
QString ParamListDescription(const int &group, const int ¶m, const int &option) const
Returns the full description for a specific option to a parameter.
Definition: IsisAml.cpp:1645
QString minimum_inclusive
Definition: IsisAmlData.h:64
QString ParamGreaterThan(const int &group, const int ¶m, const int &great) const
Returns the name of the specified greaterThan parameter.
Definition: IsisAml.cpp:1387
int ToInteger() const
Returns the object string as an integer.
Definition: IString.cpp:718
QString pixelType
Definition: IsisAmlData.h:81
QString ParamDefault(const int &group, const int ¶m) const
Returns the default for a parameter in a specified group.
Definition: IsisAml.cpp:1505
QString toString(bool boolToConvert)
Global function to convert a boolean to a string.
Definition: IString.cpp:211
void GetAsString(const QString ¶mName, std::vector< QString > &values) const
Definition: IsisAmlData.h:124
bool IsParamInPvlInclude(QString ¶mName, std::vector< QString > &exclude)
Verify whether Parameter name is in the Include list Used in creation of DefFile.
Definition: IsisAml.cpp:1191
QString ParamListBrief(const int &group, const int ¶m, const int &option) const
Returns the brief description for a specific option to a parameter.
Definition: IsisAml.cpp:1630
Isis::CubeAttributeInput & GetInputAttribute(const QString ¶mName)
Gets the attributes for an input cube.
Definition: IsisAml.cpp:1874
int ParamIncludeSize(const int &group, const int ¶m) const
Returns the number of parameters included in this parameter's inclusions.
Definition: IsisAml.cpp:1731
QString ParamType(const int &group, const int ¶m) const
Returns the parameter type of a parameter in a specified group.
Definition: IsisAml.cpp:1492
QString ParamInternalDefault(const int &group, const int ¶m) const
Returns the internal default for a parameter in a specified group.
Definition: IsisAml.cpp:1524
std::vector< QString > notEqual
Definition: IsisAmlData.h:72
void GetString(const QString ¶mName, std::vector< QString > &values) const
void addAttributes(const FileName &fileNameWithAtts)
Append the attributes found in the filename to these cube attributes.
Definition: CubeAttribute.h:222
int ParamListExcludeSize(const int &group, const int ¶m, const int &option) const
Returns the number of items in a parameters list exclude section.
Definition: IsisAml.cpp:1660
void setAttributes(const FileName &fileName)
Replaces the current attributes with the attributes in the given file name.
Definition: CubeAttribute.h:262
QString ParamPath(const int &group, const int ¶m) const
Returns the default path for a filename/cube parameter.
Definition: IsisAml.cpp:1562
IString UpCase()
Converst any lower case characters in the object IString with uppercase characters.
Definition: IString.cpp:617
bool GetBoolean(const QString ¶mName) const
Allows the retrieval of a value for a parameter of type "boolean".
Definition: IsisAml.cpp:973
QString GroupName(const int &group) const
Returns the group name of group[index].
Definition: IsisAml.cpp:1098
void VerifyAll()
Verify all parameters.
Definition: IsisAml.cpp:2387
QString expanded() const
Returns a QString of the full file name including the file path, excluding the attributes.
Definition: FileName.cpp:196
QString name
Definition: IsisAmlData.h:56
int ParamNotEqualSize(const int &group, const int ¶m) const
Returns the number of values in the not equal list.
Definition: IsisAml.cpp:1374
Contains multiple PvlContainers.
Definition: PvlGroup.h:41
int GroupIndex(const QString &grpName) const
Given the group name get its index in group array.
Definition: IsisAml.cpp:1112
QString HelperBrief(const int &group, const int ¶m, const int &helper) const
Returns the brief description of the helper button.
Definition: IsisAml.cpp:1796
FileName addExtension(const QString &extension) const
Adds a new extension to the file name.
Definition: FileName.cpp:225
#define _FILEINFO_
Macro for the filename and line number.
Definition: IException.h:24
std::vector< QString > defaultValues
Definition: IsisAmlData.h:60
IsisAml(const QString &xmlfile)
Constructs an IsisAml object and internalizes the XML data in the given file name.
Definition: IsisAml.cpp:38
QString odd
Definition: IsisAmlData.h:75
QString toString() const
Returns a string representation of this exception.
Definition: IException.cpp:537
std::vector< QString > exclude
Definition: IsisAmlData.h:73
~IsisAml()
Destructs an IsisAml object.
Definition: IsisAml.cpp:45
int toInt(const QString &string)
Global function to convert from a string to an integer.
Definition: IString.cpp:93
QString type
Definition: IsisAmlData.h:59
Application program XML file parameter manager.
Definition: IsisAml.h:138
QString ParamDescription(const int &group, const int ¶m) const
Returns the long description of a parameter in a specified group.
Definition: IsisAml.cpp:1245
QString ParamExclude(const int &group, const int ¶m, const int &exclude) const
Returns the name of the specified excluded parameter.
Definition: IsisAml.cpp:1462
QString ParamFileMode(const int &group, const int ¶m) const
Returns the file mode for a parameter in a specified group.
Definition: IsisAml.cpp:1581
QString ParamNotEqual(const int &group, const int ¶m, const int ¬Eq) const
Returns the name of the specified notEqual parameter.
Definition: IsisAml.cpp:1447
QString ParamListInclude(const int &group, const int ¶m, const int &option, const int &include) const
Returns the parameter name to be included if this option is selected.
Definition: IsisAml.cpp:1705
QString ParamMinimum(const int &group, const int ¶m) const
Returns the minimum value of a parameter in a specified group.
Definition: IsisAml.cpp:1258
std::vector< QString > lessThanOrEqual
Definition: IsisAmlData.h:71
int ParamExcludeSize(const int &group, const int ¶m) const
Returns the number of parameters excluded in this parameter's exclusions.
Definition: IsisAml.cpp:1719
QString ParamListExclude(const int &group, const int ¶m, const int &option, const int &exclude) const
Returns the parameter name to be excluded if this option is selected.
Definition: IsisAml.cpp:1675
QString ParamInclude(const int &group, const int ¶m, const int &include) const
Returns the name of the specified included parameter.
Definition: IsisAml.cpp:1477
std::vector< QString > lessThan
Definition: IsisAmlData.h:70
const IsisParameterData * ReturnParam(const QString ¶mName) const
Returns a pointer to a parameter whose name starts with paramName.
Definition: IsisAml.cpp:1965
Isis exception class.
Definition: IException.h:91
std::vector< QString > greaterThan
Definition: IsisAmlData.h:68
void GetInteger(const QString ¶mName, std::vector< int > &values) const
QString PixelType(const int &group, const int ¶m) const
Returns the default pixel type from the XML.
Definition: IsisAml.cpp:1743
int ParamGreaterThanOrEqualSize(const int &group, const int ¶m) const
Returns the number of values in the parameters greater than or equal list.
Definition: IsisAml.cpp:1336
int ParamGreaterThanSize(const int &group, const int ¶m) const
Returns the number of values in the parameters greater than list.
Definition: IsisAml.cpp:1324
QString ParamLessThan(const int &group, const int ¶m, const int &great) const
Returns the name of the specified lessThan parameter.
Definition: IsisAml.cpp:1417
QString Version() const
Returns the application version date.
Definition: IsisAml.cpp:2987
void addGroup(const Isis::PvlGroup &group)
Add a group to the object.
Definition: PvlObject.h:186
void PutAsString(const QString ¶mName, const std::vector< QString > &value)
bool StringToBool(QString value) const
Returns a boolean value based on the QString contents.
Definition: IsisAml.cpp:2867
int ParamListIncludeSize(const int &group, const int ¶m, const int &option) const
Returns the number of items in a parameters list include section.
Definition: IsisAml.cpp:1690
void Clear(const QString ¶mName)
Clears the value(s) in the named parameter.
Definition: IsisAml.cpp:1852
void deleteKeyword(const QString &name)
Remove a specified keyword.
Definition: PvlContainer.cpp:97
bool WasEntered(const QString ¶mName) const
Returns a true if the parameter has a value, and false if it does not.
Definition: IsisAml.cpp:1836
Isis::CubeAttributeInput inCubeAtt
Definition: IsisAmlData.h:80
QString maximum_inclusive
Definition: IsisAmlData.h:66
int ParamLessThanSize(const int &group, const int ¶m) const
Returns the number of values in the parameters less than list.
Definition: IsisAml.cpp:1349
QString Brief() const
Returns the brief description of the program.
Definition: IsisAml.cpp:1068
int GetInteger(const QString ¶mName) const
Allows the retrieval of a value for a parameter of type "integer".
Definition: IsisAml.cpp:807
@ Programmer
This error is for when a programmer made an API call that was illegal.
Definition: IException.h:146
Namespace for the standard library.
QString minimum
Definition: IsisAmlData.h:65
int ParamLessThanOrEqualSize(const int &group, const int ¶m) const
Returns the number of values in the parameters less than or equal list.
Definition: IsisAml.cpp:1361
std::vector< QString > greaterThanOrEqual
Definition: IsisAmlData.h:69
QString Description() const
Returns the full description of the program.
Definition: IsisAml.cpp:1078
QString GetString(const QString ¶mName) const
Allows the retrieval of a value for a parameter of type "string".
Definition: IsisAml.cpp:692
std::vector< QString > values
Definition: IsisAmlData.h:55
QString HelperButtonName(const int &group, const int ¶m, const int &helper) const
Returns the name of the helper button.
Definition: IsisAml.cpp:1768
bool toBool(const QString &string)
Global function to convert from a string to a boolean.
Definition: IString.cpp:38
void CommandLine(Isis::Pvl &lab) const
Creates a QString which could be used as a command line.
Definition: IsisAml.cpp:2910
QString internalDefault
Definition: IsisAmlData.h:61
void PutInteger(const QString ¶mName, const int &value)
Allows the insertion of a value for a parameter of type "integer".
Definition: IsisAml.cpp:275
QString ParamLessThanOrEqual(const int &group, const int ¶m, const int &les) const
Returns the name of the specified lessThanOrEqual parameter.
Definition: IsisAml.cpp:1432
void PutDouble(const QString ¶mName, const double &value)
Allows the insertion of a value for a parameter of type "double".
Definition: IsisAml.cpp:361
void PutInteger(const QString ¶mName, const std::vector< int > &value)
Adds specific functionality to C++ strings.
Definition: IString.h:165
PvlKeyword & findKeyword(const QString &name)
Find a keyword with a specified name.
Definition: PvlContainer.cpp:62
QString ParamFilter(const int &group, const int ¶m) const
Returns the parameter filter for a parameter in a specified group.
Definition: IsisAml.cpp:1543
static Preference & Preferences(bool unitTest=false)
Definition: Preference.cpp:86
Isis::CubeAttributeOutput outCubeAtt
Definition: IsisAmlData.h:79
QString ParamMaximumInclusive(const int &group, const int ¶m) const
Returns whether the maximum value is inclusive or not.
Definition: IsisAml.cpp:1297
QString ProgramName() const
Returns the Program name.
Definition: IsisAml.cpp:1057
void GetDouble(const QString ¶mName, std::vector< double > &values) const
QString fileMode
Definition: IsisAmlData.h:78
QString ParamOdd(const int &group, const int ¶m) const
Returns whether the selected parameter has a restriction on odd values or not.
Definition: IsisAml.cpp:1311
QString ParamName(const int &group, const int ¶m) const
Returns the parameter name.
Definition: IsisAml.cpp:1219
void PutFileName(const QString ¶mName, const std::vector< QString > &value)
@ User
A type of error that could only have occurred due to a mistake on the user's part (e....
Definition: IException.h:126
int NumParams(const int &) const
Returns the number of parameters in a group.
Definition: IsisAml.cpp:1207