Class SpiceQL::Kernel

ClassList > SpiceQL > Kernel

#include <spice_types.h>

Public Types

Type	Name
enum	Quality Enumeration representing the different possible kernel qualities.
enum	Type Enumeration representing the different possible kernel types.

Public Attributes

Type	Name
std::string	path
Quality	quality
Type	type

Public Functions

Type	Name
	Kernel (std::string path) Instantiate a kernel from path.
	~Kernel () Construct a new Kernel object from another.

Public Static Functions

Type	Name
std::vector< Kernel::Quality >	translateQualities (std::vector< std::string > qas) Switch between Kernel quality string to enum.
std::string	translateQuality (Quality qa) Switch between Quality enum to string.
Quality	translateQuality (std::string qa) Switch between Kernel quality string to enum.
std::string	translateType (Type type) Switch between Kernel type enum to string.
Type	translateType (std::string type) Switch between Kernel type string to enum.

Detailed Description

This is mostly designed to enable the automatic unloading of kernels. The kernel is furnsh-ed on instantiation and unloaded in the destructor.

Public Types Documentation

enum Quality

Enumeration representing the different possible kernel qualities.

enum SpiceQL::Kernel::Quality {
    NOQUALITY =0,
    NADIR = 1,
    PREDICTED = 2,
    RECONSTRUCTED = 3,
    SMITHED = 4
};

enum Type

Enumeration representing the different possible kernel types.

enum SpiceQL::Kernel::Type {
    NA =0,
    CK,
    SPK,
    TSPK,
    LSK,
    MK,
    SCLK,
    IAK,
    IK,
    FK,
    DSK,
    PCK,
    EK
};

Public Attributes Documentation

variable path

std::string SpiceQL::Kernel::path;

path to the kernel

variable quality

Quality SpiceQL::Kernel::quality;

quality of the kernel

variable type

Type SpiceQL::Kernel::type;

type of kernel

Public Functions Documentation

function Kernel

Instantiate a kernel from path.

SpiceQL::Kernel::Kernel (
    std::string path
)

Load a kernel into memory by opening the kernel and furnishing. This also increases the reference count of the kernel. If the kernel has alrady been furnished, it is refurnshed.

Parameters:

path path to a kernel.

function ~Kernel

Construct a new Kernel object from another.

SpiceQL::Kernel::~Kernel ()

Ensures the reference counter is incremented when a copy of the kernel is created

Parameters:

other some other Kernel instance

Delete the kernel object and decrease it's reference count

Deletes the kernel object and decrements it's reference count. If the reference count hits 0, the kernel is unloaded.

Public Static Functions Documentation

function translateQualities

Switch between Kernel quality string to enum.

static std::vector< Kernel::Quality > SpiceQL::Kernel::translateQualities (
    std::vector< std::string > qas
)

Parameters:

qas Vector of Kernel::Quality strings

Returns:

Vector of Kernel::Quality values

function translateQuality [1/2]

Switch between Quality enum to string.

static std::string SpiceQL::Kernel::translateQuality (
    Quality qa
)

Parameters:

qa Kernel::Quality to translate to a string

Returns:

String representation of the kernel type, eg. Kernel::Quality::Reconstructed returns "reconstructed"

function translateQuality [2/2]

Switch between Kernel quality string to enum.

static Quality SpiceQL::Kernel::translateQuality (
    std::string qa
)

Parameters:

qa String to translate to a Kernel::Quality, must be all lower case

Returns:

Kernel::Type representation of the kernel type, eg. "reconstructed" returns Kernel::Quality::Reconstructed

function translateType [1/2]

Switch between Kernel type enum to string.

static std::string SpiceQL::Kernel::translateType (
    Type type
)

Parameters:

type Kernel::Type to translate to a string

Returns:

String representation of the kernel type, eg. Kernel::Type::CK returns "ck"

function translateType [2/2]

Switch between Kernel type string to enum.

static Type SpiceQL::Kernel::translateType (
    std::string type
)

Parameters:

type String to translate to a Kernel::Type, must be all lower case

Returns:

Kernel::Type representation of the kernel type, eg. "ck" returns Kernel::Type::CK

The documentation for this class was generated from the following file SpiceQL/include/spice_types.h