 |
Isis Developer Reference
|
|
Isis Developer Reference
|
Manipulate and parse attributes of input cube filenames. More...
#include <CubeAttribute.h>
Public Member Functions | |
| CubeAttributeInput () | |
| Constructs an empty CubeAttributeInput. More... | |
| CubeAttributeInput (const FileName &fileName) | |
| Constructs a CubeAttributeInput and initialized it with the contents of the string parameter. More... | |
| ~CubeAttributeInput () | |
| Destroys the object. More... | |
| std::vector< QString > | bands () const |
| Return a vector of the input bands specified. More... | |
| QString | bandsString () const |
| Return a string representation of all the bands. More... | |
| void | setBands (const std::vector< QString > &bands) |
| Set the band attribute according to the list of bands. More... | |
| QString | toString () const |
| Return a string-representation of this cube attributes. More... | |
| void | addAttribute (QString attribute) |
| Add a single attribute to these attributes. More... | |
| void | addAttributes (const FileName &fileNameWithAtts) |
| Append the attributes found in the filename to these cube attributes. More... | |
| void | addAttributes (const char *attributesString) |
| Append the attributes in the string to these cube attributes. More... | |
| void | addAttributes (const QString &attributesString) |
| Append the attributes in the string to these cube attributes. More... | |
| void | setAttributes (const FileName &fileName) |
| Replaces the current attributes with the attributes in the given file name. More... | |
Protected Member Functions | |
| QStringList | attributeList (bool(ChildClass::*tester)(QString) const) const |
| Get a list of attributes that the tester returns true on. More... | |
| void | setAttribute (QString newValue, bool(ChildClass::*tester)(QString) const) |
| Set the attribute(s) for which tester returns true to newValue. More... | |
Manipulate and parse attributes of input cube filenames.
This class provides parsing and manipulation of attributes associated with input cube filenames. Input cube filenames can have an attribute of "band(s) specification"
| Isis::CubeAttributeInput::CubeAttributeInput | ( | ) |
Constructs an empty CubeAttributeInput.
| Isis::CubeAttributeInput::CubeAttributeInput | ( | const FileName & | fileName | ) |
Constructs a CubeAttributeInput and initialized it with the contents of the string parameter.
The string is parsed to obtain any band specifiers. Any attribute information that is not valid for an input cube will throw an error.
| att | The attribute string to be parsed. |
| Isis::CubeAttributeInput::~CubeAttributeInput | ( | ) |
Destroys the object.
|
inlineinherited |
Add a single attribute to these attributes.
This attribute should NOT have a '+' in it. For example, if you wanted to add BandSequential to the CubeAttributeOutput class, you could call addAttribute("BSQ") or addAttribute("BandSequential") or any valid deviation of that string. This will preserve existing attributes unless it's of the same type (if Tile was already set, then this will overwrite Tile). If the attribute is unrecognized or ambiguous, then an exception will be thrown.
| attribute | The attribute we're adding to the current cube attributes |
|
inlineinherited |
Append the attributes in the string to these cube attributes.
This will call addAttribute() for every attribute in the string. The initial "+" is not expected but allowed. This should NOT be called with a file name.
| attributesString | A string of recognizable attributes, for example "+Bsq+Real" or "Bsq+Real" |
|
inlineinherited |
Append the attributes found in the filename to these cube attributes.
This will call addAttribute() for every attribute found in the file name.
| fileNameWithAtts | A filename with attributes appended, for example FileName("out.cub+Bsq") |
|
inlineinherited |
Append the attributes in the string to these cube attributes.
| attributesString | A string of recognizable attributes, for example "+Bsq+Real" or "Bsq+Real" |
|
inlineprotectedinherited |
Get a list of attributes that the tester returns true on.
This is helpful for accessing the values of existing attributes. The strings will always be the UPPER CASE version of the attribute, i.e. not Bsq but BSQ. The returned attributes do not contain delimiters.
| tester | A method that determines whether the attribute should be returned/is relevant |
| vector< QString > Isis::CubeAttributeInput::bands | ( | ) | const |
Return a vector of the input bands specified.
Parse the string parameter and populate the private variable accordinly.
| att | A string containing the file attributes. All characters before the first "+" are assumed to be the filename and are ignored. |
References Isis::toInt(), Isis::CubeAttribute< CubeAttributeInput >::toString(), and Isis::toString().
Referenced by Isis::Workspace::addCubeViewport(), Isis::Workspace::addCubeViewportFromList(), bandsString(), Isis::CubeManager::OpenCube(), Isis::GuiInputAttribute::SetAttributes(), setBands(), and Isis::Process::SetInputCube().
| QString Isis::CubeAttributeInput::bandsString | ( | ) | const |
Return a string representation of all the bands.
References bands(), and Isis::CubeAttribute< CubeAttributeInput >::toString().
|
inlineprotectedinherited |
Set the attribute(s) for which tester returns true to newValue.
If multiple attributes match (tester returns true on them), only the first one is preserved and it's value becomes newValue. Subsequent matching attributes are removed/deleted. This is done to simplify the resulting attribute string to be minimal with this particular attribute.
| newValue | The string to set the attribute to... tester(newValue) really ought to return true. |
| tester | A method that determines if an attribute is of the same type of newValue, so that existing attributes can be overwritten. |
|
inlineinherited |
Replaces the current attributes with the attributes in the given file name.
This will call addAttribute() for every attribute in the file name.
| fileName | A file name with (or without) attributes on the end, for example FileName("out.cub+Bsq") |
| void Isis::CubeAttributeInput::setBands | ( | const std::vector< QString > & | bands | ) |
Set the band attribute according to the list of bands.
References bands(), Isis::CubeAttribute< CubeAttributeInput >::setAttributes(), and Isis::CubeAttribute< CubeAttributeInput >::toString().
|
inlineinherited |
Return a string-representation of this cube attributes.
This will typically be exactl the string passed in if you used setAttributes(...). This can be an empty string ("") or if there are attributes then it will be +att1+att2+... The result of this method could be used to re-create this instance.