Pointing.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2004 - 2023 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/Base/Extensions/Pulsar/Pointing.h
 
#ifndef __Pulsar_Pointing_h
#define __Pulsar_Pointing_h
 
#include "Pulsar/IntegrationExtension.h"
#include "Angle.h"
#include "Estimate.h"
#include "TextInterface.h"
 
namespace Pulsar {
  
  class Pointing : public Pulsar::Integration::Extension {
    
  public:
    
    Pointing ();
 
    Pointing (const Pointing& extension);
 
    const Pointing& operator= (const Pointing& extension);
    
    ~Pointing ();
 
    Pointing* clone () const { return new Pointing( *this ); }
    
    TextInterface::Parser* get_interface();
    
    // Text interface to a Pointing instance
    class Interface : public TextInterface::To<Pointing>
    {
      public:
          Interface( Pointing *s_instance = NULL );
    };
 
    const Pointing& operator += (const Pointing& extension);
 
    void integrate (const Integration* subint);
 
    void update (const Integration* subint);
 
    void update (const Integration* subint, const Archive *archive);
 
 
    void set_local_sidereal_time (double seconds);
    double get_local_sidereal_time () const;
 
    void set_right_ascension (const Angle&);
    Angle get_right_ascension () const;
 
    void set_declination (const Angle&);
    Angle get_declination () const;
 
    void set_galactic_longitude (const Angle&);
    Angle get_galactic_longitude () const;
 
    void set_galactic_latitude (const Angle&);
    Angle get_galactic_latitude () const;
 
    void set_feed_angle (const Angle&);
    Angle get_feed_angle () const;
 
    void set_position_angle (const Angle&);
    Angle get_position_angle () const;
 
    void set_parallactic_angle (const Angle&);
    Angle get_parallactic_angle () const;
 
    void set_telescope_azimuth (const Angle&);
    Angle get_telescope_azimuth () const;
 
    void set_telescope_zenith (const Angle&);
    Angle get_telescope_zenith () const;
 
    class Info: public Reference::Able
    {
      std::string name;
      std::string unit;
      std::string description;
      double value;
 
      public:
 
      Info () { value = 0; }
 
      const std::string& get_name () const { return name; }
      void set_name (const std::string& _name) { name = _name; }
 
      const std::string& get_unit () const { return unit; }
      void set_unit (const std::string& _unit) { unit = _unit; }
 
      const std::string& get_description () const { return description; }
      void set_description (const std::string& _desc) { description = _desc; }
 
      double get_value () const { return value; }
      void set_value (double val) { value = val; }
 
      TextInterface::Parser* get_interface();
  
      // Text interface to a Pointing instance
      class Interface : public TextInterface::To<Info>
      {
        public:
            Interface( Info *s_instance = NULL );
      };
 
    };
 
    unsigned get_ninfo () const;
    void add_info (Info*);
 
    Info* get_info (unsigned index);
    const Info* get_info (unsigned index) const;
 
    const Info* find_info (const std::string&) const;
    Info* find_info (const std::string&);
 
    double get_value (const std::string&) const;
    void set_value (const std::string&, double value);
    TextInterface::Parser* get_value_interface (const std::string&);
 
    std::string list_info () const;
    void edit_info (const std::string&);
 
 
    std::string get_short_name () const { return "point"; }
 
  protected:
 
    MeanRadian<double> local_sidereal_time;
    
    MeanRadian<double> right_ascension;
 
    MeanRadian<double> declination;
 
    MeanRadian<double> galactic_longitude;
 
    MeanRadian<double> galactic_latitude;
 
    MeanRadian<double> feed_angle;
 
    MeanRadian<double> position_angle;
 
    MeanRadian<double> parallactic_angle;
 
    MeanRadian<double> telescope_azimuth;
 
    MeanRadian<double> telescope_zenith;
 
    std::vector< Reference::To<Info> > info;
  };
  
}
 
#endif