#include <DimensionDescriptor.h>
Public Member Functions | |
| DimensionDescriptor () | |
| BROKEN_INLINE_HINT DimensionDescriptor & | operator= (const DimensionDescriptor &descriptor) |
| bool | operator!= (const DimensionDescriptor &dd) const |
| bool | operator== (const DimensionDescriptor &dd) const |
| bool | operator< (const DimensionDescriptor &right) const |
| bool | operator> (const DimensionDescriptor &right) const |
| void | setOriginalNumber (unsigned int originalNumber) |
| unsigned int | getOriginalNumber () const |
| bool | isOriginalNumberValid () const |
| void | setOriginalNumberValid (bool valid) |
| void | setOnDiskNumber (unsigned int onDiskNumber) |
| unsigned int | getOnDiskNumber () const |
| bool | isOnDiskNumberValid () const |
| void | setOnDiskNumberValid (bool valid) |
| void | setActiveNumber (unsigned int activeNumber) |
| unsigned int | getActiveNumber () const |
| bool | isActiveNumberValid () const |
| void | setActiveNumberValid (bool valid) |
| bool | isValid () const |
This class is used to maintain information specific for a particular row, column, or band within a data set. There will be one instance of this class for each row, column, and band in the data set.
The object contains three identifying numbers: original, on-disk, and active as described below. Each number will have a valid or invalid state that indicates whether the get methods should be called.
Original Number
The original number represents the row, column, or band number that pertains to the original raw data from the sensor. This value is set by an importer inside of Importer::getImportDescriptors() or by an object that creates a data set as a result of running an algorithm. All instances of this object should have a valid original number.
On-Disk Number
The on-disk number represents the row, column, or band number as it corresponds to the total number of rows, columns, or bands in a file on disk. This value is set by an importer inside of Importer::getImportDescriptors(). If the data set for this row, column, or band was created by an object as a result of running an algorithm or otherwise not originally imported from a file, the on-disk number will be invalid. Each row, column, and band object inside a RasterFileDescriptor should have a valid on-disk number.
Active Number
The active number represents the row, column, or band number that is available for processing. This value is set by the core application just before an importer is executed and after the user has specified an optional subset, or by an object that creates a data set as a result of running an algorithm. If a subset of a data set has been imported, the active number will be valid only for the rows, columns, and bands that have been imported. In this case, all rows, columns, and bands in the RasterDataDescriptor will have valid active numbers, and only those rows, columns, and bands that were imported will have valid active numbers in the RasterFileDescriptor.
SampleRasterElementImporter.cpp, and SampleRasterElementImporter.h.
Definition at line 58 of file DimensionDescriptor.h.
| DimensionDescriptor::DimensionDescriptor | ( | ) |
Constructs a DimensionDescriptor that is invalid until one of the set methods is called.
Definition at line 65 of file DimensionDescriptor.h.
| BROKEN_INLINE_HINT DimensionDescriptor& DimensionDescriptor::operator= | ( | const DimensionDescriptor & | descriptor | ) |
Assignment operator for DimensionDescriptor.
| descriptor | the right hand side of the assignment. |
Definition at line 82 of file DimensionDescriptor.h.
| bool DimensionDescriptor::operator!= | ( | const DimensionDescriptor & | dd | ) | const |
Inequality operator for DimensionDescriptor.
| dd | the object being compared to. |
Definition at line 105 of file DimensionDescriptor.h.
| bool DimensionDescriptor::operator== | ( | const DimensionDescriptor & | dd | ) | const |
Equality operator for DimensionDescriptor.
| dd | the object being compared to. |
Definition at line 118 of file DimensionDescriptor.h.
| bool DimensionDescriptor::operator< | ( | const DimensionDescriptor & | right | ) | const |
Less than operator for DimensionDescriptor.
This method provides a guaranteed ordering of DimensionDescriptors. This operator should only be used to perform unique sorting of DimensionDescriptors, ie. the kind required to use a DimensionDescriptor as a key of std::map.
| right | the object being compared to. |
Definition at line 142 of file DimensionDescriptor.h.
| bool DimensionDescriptor::operator> | ( | const DimensionDescriptor & | right | ) | const |
Greater than operator for DimensionDescriptor.
This method provides a guaranteed ordering of DimensionDescriptors. This operator should only be used to perform unique sorting of DimensionDescriptors, ie. the kind required to use a DimensionDescriptor as a key of std::map.
| right | the object being compared to. |
Definition at line 201 of file DimensionDescriptor.h.
| void DimensionDescriptor::setOriginalNumber | ( | unsigned int | originalNumber | ) |
Sets the original number for the row, column, or band.
The original number indicates the initial index of the row, column, or band from the dataset generated by the sensor.
The original number is automatically made valid when this method is called, so there is no need to call setOriginalNumberValid().
| originalNumber | The zero-based number of the row, column, or band in the original data set. |
Definition at line 261 of file DimensionDescriptor.h.
| unsigned int DimensionDescriptor::getOriginalNumber | ( | ) | const |
Returns the original number of the row, column, or band.
To ensure that the number returned is valid, call the isOriginalNumberValid() method before calling this method.
Definition at line 276 of file DimensionDescriptor.h.
| bool DimensionDescriptor::isOriginalNumberValid | ( | ) | const |
Queries whether the original number of the row, column, or band is valid.
Definition at line 287 of file DimensionDescriptor.h.
| void DimensionDescriptor::setOriginalNumberValid | ( | bool | valid | ) |
Sets whether the original number of the row, column, or band is valid.
An invalid number is automatically made valid when setOriginalNumber() is called. Therefore, this method is typically called to invalidate the original number.
| valid | The new valid state of the original number. |
Definition at line 302 of file DimensionDescriptor.h.
| void DimensionDescriptor::setOnDiskNumber | ( | unsigned int | onDiskNumber | ) |
Sets the on-disk number for the row, column, or band.
The on-disk number indicates the index of the row, column, or band as it is stored in the file on disk. The current file may be reduced from the original sensor data file if a subset has been saved.
The on-disk number is automatically made valid when this method is called, so there is no need to call setOnDiskNumberValid().
| onDiskNumber | The zero-based number of the row, column, or band in the file on disk. |
Definition at line 321 of file DimensionDescriptor.h.
| unsigned int DimensionDescriptor::getOnDiskNumber | ( | ) | const |
Returns the on-disk number of the row, column, or band.
To ensure that the number returned is valid, call the isOnDiskNumberValid() method before calling this method.
Definition at line 336 of file DimensionDescriptor.h.
| bool DimensionDescriptor::isOnDiskNumberValid | ( | ) | const |
Queries whether the on-disk number of the row, column, or band has been set.
Definition at line 348 of file DimensionDescriptor.h.
| void DimensionDescriptor::setOnDiskNumberValid | ( | bool | valid | ) |
Sets whether the on-disk number of the row, column, or band is valid.
An invalid number is automatically made valid when setOnDiskNumber() is called. Therefore, this method is typically called to invalidate the on-disk number.
| valid | The new valid state of the on-disk number. |
Definition at line 363 of file DimensionDescriptor.h.
| void DimensionDescriptor::setActiveNumber | ( | unsigned int | activeNumber | ) |
Sets the active number for the row, column, or band.
The active number indicates the index of the row, column, or band as it has been imported.
The active number is automatically made valid when this method is called, so there is no need to call setActiveNumberValid().
| activeNumber | The zero-based number of the row, column, or band as it has been imported. |
Definition at line 381 of file DimensionDescriptor.h.
| unsigned int DimensionDescriptor::getActiveNumber | ( | ) | const |
Returns the active number of the row, column, or band.
To ensure that the number returned is valid, call the isActiveNumberValid() method before calling this method.
Definition at line 396 of file DimensionDescriptor.h.
| bool DimensionDescriptor::isActiveNumberValid | ( | ) | const |
Queries whether the active number of the row, column, or band has been set.
Definition at line 408 of file DimensionDescriptor.h.
| void DimensionDescriptor::setActiveNumberValid | ( | bool | valid | ) |
Sets whether the active number of the row, column, or band is valid.
An invalid number is automatically made valid when setActiveNumber() is called. Therefore, this method is typically called to invalidate the active number.
| valid | The new valid state of the active number. |
Definition at line 423 of file DimensionDescriptor.h.
| bool DimensionDescriptor::isValid | ( | ) | const |
Queries whether this DimensionDescriptor is valid or not.
Definition at line 434 of file DimensionDescriptor.h.