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.

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.

Private Attributes
QStringList	m_kernels
	List of kernel file names.

Type	m_kernelType
	Enumeration value indicating the kernel type.

Detailed Description

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

Author: ????-??-?? Unknown

History:: 2013-02-26 Jeannie Backer - Moved this class from the KernelDb header file into it's own directory. Moved method implementation into a cpp file. Moved the KernelType enumeration from a global "spiceInit" namespace into the Kernel class and renamed it Type. Added accessor and mutator methods. Changed method names to lower camel case and changed member variable prefix to m_ to comply with Isis3 standards. Documented enumeration, methods, member variables. Created unitTest.References #924.

Definition at line 49 of file Kernel.h.

Member Enumeration Documentation

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.

Definition at line 54 of file Kernel.h.

Constructor & Destructor Documentation

Isis::Kernel::Kernel ( )

Constructs a Kernel object with "Unknown" Type.

Definition at line 32 of file Kernel.cpp.

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)

Definition at line 50 of file Kernel.cpp.

Isis::Kernel::~Kernel ( )

Destructs Kernel object.

Definition at line 40 of file Kernel.cpp.

Member Function Documentation

QStringList Isis::Kernel::kernels ( )

Returns the list of kernel data file names.

Returns: QStringList List of file names for the kernel

Definition at line 106 of file Kernel.cpp.

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.

Definition at line 181 of file Kernel.cpp.

References m_kernelType.

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

Definition at line 157 of file Kernel.cpp.

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

Definition at line 169 of file Kernel.cpp.

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.

Definition at line 146 of file Kernel.cpp.

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)

Definition at line 122 of file Kernel.cpp.

void Isis::Kernel::setType ( const Type & type )

Sets the Kernel type.

Parameters

type	The Kernel type enumeration value to be set.

Definition at line 130 of file Kernel.cpp.

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

Definition at line 138 of file Kernel.cpp.

Kernel::Type Isis::Kernel::type ( )

Returns the stored Kernel::Type.

Returns: Type Enumerated kernel type value

Definition at line 114 of file Kernel.cpp.

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

Definition at line 70 of file Kernel.cpp.

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.

Definition at line 93 of file Kernel.cpp.

Member Data Documentation

QStringList Isis::Kernel::m_kernels

private

List of kernel file names.

Definition at line 87 of file Kernel.h.

Type Isis::Kernel::m_kernelType

private

Enumeration value indicating the kernel type.

Definition at line 88 of file Kernel.h.

Referenced by operator<().

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

src/system/objs/Kernel/Kernel.h
src/system/objs/Kernel/Kernel.cpp

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation