Moves SPICEKernels types into base package

Author: Joey Carpinelli

lib/EphemerisSourcesBase/Project.toml

@@ -1,7 +1,7 @@
 name = "EphemerisSourcesBase"
 uuid = "b8f1d712-e88d-4f2a-8498-e66ce688ee29"
 authors = ["Joey Carpinelli <[email protected]>"]
-version = "0.1.2"
+version = "0.2.0"
 
 [deps]
 AstroTime = "c61b5328-d09d-5e37-a9a8-0eb41c39009c"

lib/EphemerisSourcesBase/docs/src/reference/index.md

@@ -5,6 +5,7 @@ _All docstrings!_
 ```@autodocs
 Modules = [
     EphemerisSourcesBase,
+    EphemerisSourcesBase.Types
 ]
 Order = [:module, :type, :function, :constant]
 ```

lib/EphemerisSourcesBase/src/EphemerisSourcesBase.jl

@@ -52,5 +52,7 @@ function naifcode(name::Union{<:AbstractString,Symbol})
     end
 end
 
+include("types.jl")
+
 
 end # module EphemerisSourcesBase

lib/EphemerisSourcesBase/src/types.jl

@@ -0,0 +1,151 @@
+#
+# Abstract and concrete types, and methods, for SPICE kernels
+#
+
+module Types
+
+"""
+A supertype for all SPICE Kernels! To satisfy the `SPICEKernel` interface, your new type
+must implement each of the methods below.
+
+- `SPICEKernels.type(kernel)::AbstractString`
+- `SPICEKernels.path(kernel)::AbstractString`
+"""
+abstract type SPICEKernel end
+
+
+function (kernel::SPICEKernel)(; ignorecache = false, directory = SPICE_KERNEL_DIR)
+    return fetchkernel(path(kernel); ignorecache = ignorecache, directory = directory)
+end
+
+"""
+Return the underlying SPICE kernel type.
+"""
+function type end
+
+"""
+Return the path to the kernel. This can be a URL!
+"""
+function path end
+
+"""
+A supertype representing Digital Shape Kernels (DSK).
+"""
+abstract type DigitalShapeKernel <: SPICEKernel end
+
+"""
+A supertype representing Frames Kernels (FK).
+"""
+abstract type FramesKernel <: SPICEKernel end
+
+"""
+A supertype representing Leapseconds Kernels (LSK).
+"""
+abstract type LeapSecondsKernel <: SPICEKernel end
+
+"""
+A supertype representing Planetary Constants Kernels (PCK).
+"""
+abstract type PlanetaryConstantsKernel <: SPICEKernel end
+
+"""
+A supertype representing Spacecraft and Planet Kernels, also known as ephemeris kernels (SPK).
+"""
+abstract type EphemerisKernel <: SPICEKernel end
+
+
+const SPICE_EXTENSIONS = Base.ImmutableDict(
+    ".bsp" => EphemerisKernel,
+    ".dsk" => DigitalShapeKernel,
+    ".pck" => PlanetaryConstantsKernel,
+    ".bds" => DigitalShapeKernel,
+    ".tf" => FramesKernel,
+    ".tpc" => PlanetaryConstantsKernel,
+    ".bpc" => PlanetaryConstantsKernel,
+    ".tls" => LeapSecondsKernel,
+    ".pc" => LeapSecondsKernel,
+)
+
+"""
+Fallback method to inspect the file extension of the provided kernel, and 
+return the expected kernel type. If the file extension is not recognized, 
+a `KeyError` is thrown.
+"""
+function type(kernel::Union{<:SPICEKernel,<:AbstractString})
+    if kernel isa SPICEKernel
+        name = basename(path(kernel))
+    else
+        name = basename(kernel)
+    end
+
+    ext = last(splitext(name))
+
+    return SPICE_EXTENSIONS[ext]
+end
+
+"""
+A planetary & spacecraft ephemeris kernel.
+"""
+struct SPK <: EphemerisKernel
+    source::String
+    SPK(source::AbstractString) = new(convert(String, source))
+end
+type(::SPK) = EphemerisKernel
+path(kernel::SPK) = kernel.source
+
+"""
+A digital shape kernel.
+"""
+struct DSK <: DigitalShapeKernel
+    source::String
+    DSK(source::AbstractString) = new(convert(String, source))
+end
+type(::DSK) = DigitalShapeKernel
+path(kernel::DSK) = kernel.source
+
+"""
+A planetary constants kernel.
+"""
+struct PCK <: PlanetaryConstantsKernel
+    source::String
+    PCK(source::AbstractString) = new(convert(String, source))
+end
+type(::PCK) = PlanetaryConstantsKernel
+path(kernel::PCK) = kernel.source
+
+"""
+A coordinate frames kernel.
+"""
+struct FK <: FramesKernel
+    source::String
+    FK(source::AbstractString) = new(convert(String, source))
+end
+type(::FK) = FramesKernel
+path(kernel::FK) = kernel.source
+
+"""
+A leapseconds kernel.
+"""
+struct LSK <: LeapSecondsKernel
+    source::String
+    LSK(source::AbstractString) = new(convert(String, source))
+end
+type(::LSK) = LeapSecondsKernel
+path(kernel::LSK) = kernel.source
+
+export EphemerisKernel,
+    FramesKernel,
+    PlanetaryConstantsKernel,
+    LeapSecondsKernel,
+    DigitalShapeKernel,
+    SPICEKernel,
+    SPICE_EXTENSIONS,
+    type,
+    path,
+    SPK,
+    DSK,
+    LSK,
+    PCK,
+    FK
+
+end

lib/EphemerisSourcesBase/test/runtests.jl

@@ -1 +1 @@
-using Test, EphemerisSourcesBase
+using Test, EphemerisSourcesBase, EphemerisSourcesBase.Types