Spice.h

Go to the documentation of this file.

#ifndef Spice_h
#define Spice_h

#include <string>
#include <vector>
#include "naif/SpiceUsr.h"
#include "naif/SpiceZfc.h"
#include "naif/SpiceZmc.h"
#include "Pvl.h"
#include "SpicePosition.h"
#include "SpiceRotation.h"

namespace Isis {
  class iTime;
  class Distance;
  class Longitude;

  class Spice {
    public:
      // constructors
      Spice(Pvl &label);
      Spice(Pvl &label, bool noTables);

      // destructor
      ~Spice();

      // Methods
      void SetTime(const iTime &time);
      void InstrumentPosition(double p[3]) const;
      void SunPosition(double p[3]) const;
      double TargetCenterDistance() const;
      Longitude SolarLongitude();
      void InstrumentVelocity(double v[3]) const;

      iTime Time() const;

      void Radii(Distance r[3]) const;

      void CreateCache(iTime startTime, iTime endTime,
                       const int size, double tol);
        //NO CALL TO THIS METHOD IS FOUND IN ISIS.  COMMENT OUT AND SAVE FOR AT LEAST 3 MONTHS
        //IF NO NEED IS FOUND FOR IT, DELETE METHOD.
        // 2011-02-08 JEANNIE WALLDREN
//      void CreateCache(const double time, double tol);
      iTime CacheStartTime() const;
      iTime CacheEndTime() const;

      void SubSpacecraftPoint(double &lat, double &lon);
      void SubSolarPoint(double &lat, double &lon);

      iString Target() const;

      bool IsSky() const {
        return p_sky;
      };

      iTime getClockTime(iString clockValue,
                         int sclkCode = -1);
      SpiceDouble GetDouble(const iString &key, int index = 0);
      SpiceInt GetInteger(const iString &key,   int index = 0);
      iString GetString(const iString &key,     int index = 0);

      SpicePosition *SunPosition() const {
        return p_sunPosition;
      };

      SpicePosition *InstrumentPosition() const {
        return p_instrumentPosition;
      };

      SpiceRotation *BodyRotation() const {
        return p_bodyRotation;
      };

      SpiceRotation *InstrumentRotation() const {
        return p_instrumentRotation;
      };

      bool HasKernels(Pvl &lab);

      SpiceInt NaifBodyCode() const;
      SpiceInt NaifSpkCode() const;
      SpiceInt NaifCkCode() const;
      SpiceInt NaifIkCode() const;
      SpiceInt NaifSclkCode() const;

      PvlObject getStoredNaifKeywords() const;

    protected:
      enum SpiceValueType {
        SpiceDoubleType,
        SpiceStringType,
        SpiceIntType,
        SpiceByteCodeType
      };

      QVariant readValue(iString key, SpiceValueType type, int index = 0);

      void storeResult(iString name, SpiceValueType type, QVariant value);
      QVariant getStoredResult(iString name, SpiceValueType type);

      void storeValue(iString key, int index, SpiceValueType type,
                      QVariant value);
      QVariant readStoredValue(iString key, SpiceValueType type, int index);

      // Leave these protected so that inheriting classes don't
      // have to convert between double and spicedouble
      // None of the below data elements are usable (except
      // p_radii) until SetEphemerisTime is invoked
      SpiceDouble p_uB[3];    
      SpiceDouble p_BJ[3][3]; 
      Distance *p_radii; 


    private:
      void Init(Pvl &lab, bool noTables);

      void Load(PvlKeyword &key, bool notab);
      void ComputeSolarLongitude(iTime et);

      Longitude *p_solarLongitude; 
      iTime *p_et; 
      QVector<iString> * p_kernels; 
      iString *p_target; 

      // cache stuff
      iTime *p_startTime; 
      iTime *p_endTime; 
      SpiceDouble *p_cacheSize; 

      SpiceDouble *p_startTimePadding; 
      SpiceDouble *p_endTimePadding; 

      SpicePosition *p_instrumentPosition; 
      SpiceRotation *p_instrumentRotation; 
      SpicePosition *p_sunPosition; 
      SpiceRotation *p_bodyRotation; 

      bool p_allowDownsizing; 

      // Constants
      SpiceInt *p_bodyCode;    
      SpiceInt *p_spkCode;     
      SpiceInt *p_ckCode;      
      SpiceInt *p_ikCode;      
      SpiceInt *p_sclkCode;    
      SpiceInt *p_spkBodyCode; 

      PvlObject *p_naifKeywords;

      bool p_sky; 
      bool p_usingNaif;

      // Don't allow copies
      Spice(const Spice &other);
      Spice &operator=(const Spice &other);
  };
}

#endif