This class stores Kernel information, including Type and kernel file names.
More...
#include <Kernel.h>
Public Member Functions |
| Kernel () |
| Constructs a Kernel object with "Unknown" Type.
|
| Kernel (Type type, const QStringList &data) |
| Constructs a Kernel object with given Type and kernels data.
|
| ~Kernel () |
| Destructs Kernel object.
|
QStringList | kernels () |
| Returns the list of kernel data file names.
|
Type | type () |
| Returns the stored Kernel::Type.
|
void | setKernels (QStringList data) |
| Sets the kernel data file names to the given list.
|
void | setType (const Type &type) |
| Sets the Kernel type.
|
const int | size () |
| Accessor method to determine the number of kernel files.
|
void | push_back (const QString &str) |
| Adds the string (file name) to the kernel data file list.
|
QString & | operator[] (const int index) |
| Returns the value (file name) in the kernel data list at the given index value.
|
QString | operator[] (const int index) const |
| A constant method that returns the value of the kernel data list at the given index value.
|
bool | operator< (const Kernel &other) const |
| Compares which Kernel object has a higher quality Type, i.e.
|
Static Public Member Functions |
static Type | typeEnum (const QString &type) |
| Converts the given string to a character as follows.
|
static const char * | typeEnum (const Type &type) |
| Converts the given Type to a character as follows.
|
Detailed Description
This class stores Kernel information, including Type and kernel file names.
- Author
- ????-??-?? Unknown
Member Enumeration Documentation
Enumeration for type of kernel.
- Enumerator:
Predicted |
Predicted Kernels are based on predicted location of the spacecraft.
|
Nadir |
Nadir Kernels mimic spacecraft pointing.
|
Reconstructed |
Reconstructed Kernels are supplemented with information on the actual position of targets and/or spacecrafts.
|
Smithed |
Smithed Kernels are generally reconstructed kernels that have been corrected.
|
Constructor & Destructor Documentation
Constructs a Kernel object with "Unknown" Type.
Constructs a Kernel object with given Type and kernels data.
- Parameters
-
type | Type of kernel to be constructed, see Kernel::Type enumerations |
data | Vector containing kernel file name(s) |
Isis::Kernel::~Kernel |
( |
| ) |
|
Member Function Documentation
Returns the list of kernel data file names.
- Returns
- QStringList List of file names for the kernel
bool Isis::Kernel::operator< |
( |
const Kernel & |
other | ) |
const |
Compares which Kernel object has a higher quality Type, i.e.
which type has a higher enumeration value.
- Parameters
-
other | The Kernel whose type value will be compared |
- Returns
- bool Indicates whether the Kernel object to the left of the operator has a larger Type enumeration than the object on the right of the operator.
QString & Isis::Kernel::operator[] |
( |
const int |
index | ) |
|
Returns the value (file name) in the kernel data list at the given index value.
- Parameters
-
index | The index value of the kernel data list |
- Returns
- QString The kernel file name stored in the given index
QString Isis::Kernel::operator[] |
( |
const int |
index | ) |
const |
A constant method that returns the value of the kernel data list at the given index value.
- Parameters
-
index | The index value of the kernel data list |
- Returns
- QString The kernel data stored in the given index
void Isis::Kernel::push_back |
( |
const QString & |
str | ) |
|
Adds the string (file name) to the kernel data file list.
- Parameters
-
str | String containing kernel file name to be added. |
Sets the kernel data file names to the given list.
- Parameters
-
data | A list containing kernel data (file names) |
void Isis::Kernel::setType |
( |
const Type & |
type | ) |
|
Sets the Kernel type.
- Parameters
-
type | The Kernel type enumeration value to be set. |
const int Isis::Kernel::size |
( |
| ) |
|
Accessor method to determine the number of kernel files.
- Returns
- const int Number of items in the kernel data list
Returns the stored Kernel::Type.
- Returns
- Type Enumerated kernel type value
Converts the given string to a character as follows.
-
"Predicted" = 1
-
"Nadir" = 2
-
"Reconstructed" = 4
-
"Smithed" = 8
-
Anything else = 0
- Parameters
-
type | A QString containing a Kernel Type. These strings are not case dependent (the type maybe written all caps, all lower, camel). |
- Returns
- Type The Kernel type enumeration value
Referenced by Isis::KernelDb::better(), and Isis::KernelDb::findAll().
const char * Isis::Kernel::typeEnum |
( |
const Type & |
type | ) |
|
|
static |
Converts the given Type to a character as follows.
-
1 = Predicted
-
2 = Nadir
-
4 = Reconstructed
-
8 = Smithed
-
Anything else = Unknown
- Parameters
-
type | The Kernel type enumeration value |
- Returns
- const char* A character array corresponding to the passed in Kernel::Type.
The documentation for this class was generated from the following files: