Isis::Kernel Class Reference

This class stores Kernel information, including Type and kernel file names. More...

#include <Kernel.h>

Collaboration diagram for Isis::Kernel:

Public Types
enum	Type { Predicted = 1 , Nadir = 2 , Reconstructed = 4 , Smithed = 8 }
	Enumeration for type of kernel. More...

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.
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

Type

enum Isis::Kernel::Type

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

Kernel() [1/2]

Isis::Kernel::Kernel

(

)

Constructs a Kernel object with "Unknown" Type.

Kernel() [2/2]

Isis::Kernel::Kernel	(	Type	type,
		const QStringList &	data )

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)

References type().

~Kernel()

Isis::Kernel::~Kernel

(

)

Destructs Kernel object.

Member Function Documentation

kernels()

QStringList Isis::Kernel::kernels

(

)

Returns the list of kernel data file names.

Returns

QStringList List of file names for the kernel

operator<()

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.

operator[]() [1/2]

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

operator[]() [2/2]

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

push_back()

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.

setKernels()

void Isis::Kernel::setKernels

(

QStringList

data

)

Sets the kernel data file names to the given list.

Parameters

data	A list containing kernel data (file names)

setType()

void Isis::Kernel::setType

(

const Type &

type

)

Sets the Kernel type.

Parameters

type	The Kernel type enumeration value to be set.

References type().

size()

int Isis::Kernel::size

(

)

Accessor method to determine the number of kernel files.

Returns

const int Number of items in the kernel data list

type()

Kernel::Type Isis::Kernel::type

(

)

Returns the stored Kernel::Type.

Returns

Type Enumerated kernel type value

Referenced by Kernel(), setType(), typeEnum(), and typeEnum().

typeEnum() [1/2]

Kernel::Type Isis::Kernel::typeEnum ( const QString & type )

static

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

References Nadir, Predicted, Reconstructed, Smithed, and type().

Referenced by Isis::KernelDb::findAll().

typeEnum() [2/2]

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.

References Nadir, Predicted, Reconstructed, Smithed, and type().

---

The documentation for this class was generated from the following files:

• /Users/acpaquette/repos/ISIS3/isis/src/system/objs/Kernel/Kernel.h
• /Users/acpaquette/repos/ISIS3/isis/src/system/objs/Kernel/Kernel.cpp