Predictor.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2007 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/Util/tempo/Pulsar/Predictor.h
 
#ifndef __PulsarPredictor_h
#define __PulsarPredictor_h
 
#include "Reference.h"
#include "Phase.h"
#include "MJD.h"
#include "Configuration.h"
 
#include <stdio.h>
 
namespace Pulsar {
 
  class Generator;


  class Predictor : public Reference::Able {
 
  public:

    enum Policy 
    {
      Input,
      Default,
      Ephemeris
    };

    static Configuration::Parameter<Policy>& get_policy ();

    static bool verbose;

    virtual Predictor* clone () const = 0;

    virtual Generator* generator () const = 0;


    virtual void insert (const Predictor*) = 0;

    virtual void keep (const std::vector<MJD>& epochs) = 0;

    virtual bool matches (const Predictor*) const = 0;

    virtual void set_observing_frequency (long double MHz) = 0;

    virtual long double get_observing_frequency () const = 0;

    virtual Phase phase (const MJD& t) const = 0;

    virtual MJD iphase (const Phase& phase, const MJD* guess = 0) const = 0;

    virtual long double frequency (const MJD& t) const = 0;

    virtual Phase dispersion (const MJD &t, long double MHz) const = 0;

    virtual void load (FILE*) = 0;

    virtual void unload (FILE*) const = 0;

    virtual void load_file (const std::string& filename);
    virtual void unload_file (const std::string& filename) const;

    static void children (std::vector< Reference::To<Predictor> >&);
 
  };
 
  std::ostream& operator<< (std::ostream& ostr, Predictor::Policy p);
 
  std::istream& operator>> (std::istream& istr, Predictor::Policy& p);
}
 
#endif