 |
Isis Developer Reference
|
|
Isis Developer Reference
|
Parent class for CubeAttributeInput and CubeAttributeOutput. More...
#include <CubeAttribute.h>
Public Member Functions | |
| CubeAttribute (QList< bool(ChildClass::*)(QString) const > testers) | |
| Constructs an empty CubeAttribute. | |
| CubeAttribute (QList< bool(ChildClass::*)(QString) const > testers, const FileName &fileName) | |
| Constructs a CubeAttribute using the argument. | |
| virtual | ~CubeAttribute () |
| Destroys the object. | |
| QString | toString () const |
| Return a string-representation of this cube attributes. | |
| void | addAttribute (QString attribute) |
| Add a single attribute to these attributes. | |
| void | addAttributes (const FileName &fileNameWithAtts) |
| Append the attributes found in the filename to these cube attributes. | |
| void | addAttributes (const char *attributesString) |
| Append the attributes in the string to these cube attributes. | |
| void | addAttributes (const QString &attributesString) |
| Append the attributes in the string to these cube attributes. | |
| void | setAttributes (const FileName &fileName) |
| Replaces the current attributes with the attributes in the given file name. | |
Protected Member Functions | |
| QStringList | attributeList (bool(ChildClass::*tester)(QString) const) const |
| Get a list of attributes that the tester returns true on. | |
| void | setAttribute (QString newValue, bool(ChildClass::*tester)(QString) const) |
| Set the attribute(s) for which tester returns true to newValue. | |
Parent class for CubeAttributeInput and CubeAttributeOutput.
This class provides common functionality for the CubeAttributeInput and CubeAttributeOutput classes. These classes are used to parse and manipulate attribute information attached to the end of a cube filename.
|
inline |
Constructs an empty CubeAttribute.
|
inline |
Constructs a CubeAttribute using the argument.
Constructs a CubeAttribute and initializes it with the contents of the string parameter. Minimal error checking is done to see if the string looks like an attribute.
| att | A string containing the file attributes. All characters before the first "+" are assumed to be the filename and are ignored. |
References Isis::CubeAttribute< ChildClass >::setAttributes().
|
inlinevirtual |
Destroys the object.
|
inline |
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 |
References _FILEINFO_, and Isis::IException::Unknown.
Referenced by Isis::CubeAttribute< ChildClass >::setAttributes().
|
inline |
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" |
References Isis::CubeAttribute< ChildClass >::addAttributes().
|
inline |
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") |
References Isis::CubeAttribute< ChildClass >::addAttributes().
Referenced by Isis::CubeAttribute< ChildClass >::addAttributes(), and Isis::CubeAttribute< ChildClass >::addAttributes().
|
inline |
Append the attributes in the string to these cube attributes.
| attributesString | A string of recognizable attributes, for example "+Bsq+Real" or "Bsq+Real" |
References Isis::CubeAttribute< ChildClass >::setAttributes(), and Isis::CubeAttribute< ChildClass >::toString().
|
inlineprotected |
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 |
|
inlineprotected |
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. |
|
inline |
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") |
References Isis::CubeAttribute< ChildClass >::addAttribute(), and Isis::FileName::attributes().
Referenced by Isis::CubeAttribute< ChildClass >::addAttributes(), and Isis::CubeAttribute< ChildClass >::CubeAttribute().
|
inline |
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.
Referenced by Isis::CubeAttribute< ChildClass >::addAttributes().