PuMaArchive.h

//-*-C++-*-
 
// psrchive/Base/Formats/PuMa/Pulsar/PuMaArchive.h
 
#ifndef __PuMaArchive_h
#define __PuMaArchive_h
 
#include "Pulsar/Archive.h"
#include "Pulsar/Agent.h"
 
// PuMa header definition
#include <pumadata.h>
 
namespace Pulsar {


  class PuMaArchive : public Archive {
 
  public:
    
    PuMaArchive ();

    PuMaArchive (const PuMaArchive& archive);

    ~PuMaArchive ();

    const PuMaArchive& operator = (const PuMaArchive& archive);
    
    PuMaArchive (const Archive& archive);

    void copy (const Archive& archive);
 
    // //////////////////////////////////////////////////////////////////
    //
    // Implementation of Pulsar::Archive pure virtual methods
    //
    // //////////////////////////////////////////////////////////////////

    Archive* clone () const;

    unsigned get_nbin () const;

    unsigned get_nchan () const;

    unsigned get_npol () const;

    unsigned get_nsubint () const;

    std::string get_telescope () const;
    void set_telescope (const std::string& telescope);

    Signal::State get_state () const;
    void set_state (Signal::State state);

    virtual Signal::Scale get_scale () const;
    virtual void set_scale (Signal::Scale scale);

    Signal::Source get_type () const;
    void set_type (Signal::Source type);

    std::string get_source () const;
    void set_source (const std::string& source);

    std::string get_backend () const;
    void set_backend (const std::string& bak);

    std::string get_receiver () const;
    void set_receiver (const std::string& rec);

    sky_coord get_coordinates () const;
    void set_coordinates (const sky_coord& coordinates);

    double get_centre_frequency () const;
    void set_centre_frequency (double cf);

    double get_bandwidth () const;
    void set_bandwidth (double bw);

    double get_dispersion_measure () const;
    void set_dispersion_measure (double dm);

    bool get_dedispersed () const;
    void set_dedispersed (bool done = true);

    double get_rotation_measure () const;
    void set_rotation_measure (double rm);

    bool get_faraday_corrected () const;
    void set_faraday_corrected (bool done = true);

    bool get_poln_calibrated () const;
    void set_poln_calibrated (bool done = true);
 
 
  protected:

    void set_nbin (unsigned numbins);

    void set_nchan (unsigned numchan);

    void set_npol (unsigned numpol);

    void set_nsubint (unsigned nsubint);

    Integration* new_Integration (const Integration* copy_this = 0);

    void load_header (const char* filename);

    static void load_header (Header_type& hdr, const char* filename);

    Integration*
    load_Integration (const char* filename, unsigned subint);

    bool can_unload () const { return true; }

    void unload_file (const char* filename) const;
 
    // //////////////////////////////////////////////////////////////////
    //
    // Pulsar::PuMaArchive::Agent
    //
    // //////////////////////////////////////////////////////////////////
 
    friend class Archive::Advocate<PuMaArchive>;

    class Agent : public Archive::Advocate<PuMaArchive> {
 
    public:

      Agent ();
      
      bool advocate (const char* filename);
      
      std::string get_name () { return "PuMa"; }
      
      std::string get_description ();
      
    };
 
  private:

    Header_type hdr;

    unsigned npol;

    Signal::State state;

    Signal::Source source;

    unsigned header_bytes;

    bool little_endian;

    void init ();

    void set_GenType (int code, bool done);
 
  };
 
 
}
 
#endif