EPNArchive.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2004 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/Base/Formats/EPN/Pulsar/EPNArchive.h
 
#ifndef __EPN_Archive_h
#define __EPN_Archive_h
 
#include "Pulsar/Archive.h"
#include "Pulsar/Agent.h"
#include "epnio.h"
 
namespace Pulsar {

  class EPNArchive : public Archive {
 
  public:

    EPNArchive ();

    EPNArchive (const EPNArchive& archive);

    ~EPNArchive ();

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

    void copy (const Archive& archive);
 
    // //////////////////////////////////////////////////////////////////
    //
    // implement the pure virtual methods of the Archive base class
    //

    EPNArchive* clone () const;

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

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

    Signal::Scale get_scale () const;
    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);

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


    unsigned get_nbin () const;


    unsigned get_nchan () const;


    unsigned get_npol () const;


    unsigned get_nsubint () const;

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

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

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

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

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

    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:
 
    friend class Archive::Advocate<EPNArchive>;
 
    // Advocates the use of the EPNArchive plugin
    class Agent : public Archive::Advocate<EPNArchive> {
    
      public:

        Agent () {}

        bool advocate (const char* filename);

        std::string get_name () { return "EPN"; }

        std::string get_description ();
 
    }; 

    void load_header (const char* filename);

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

    bool can_unload () const { return false; }

    void unload_file (const char* filename) const;

 
    epn_header_line1 line1;
 
    epn_header_line2 line2;
    
    epn_header_line3 line3;
    
    epn_header_line4 line4;
    
    epn_header_line5 line5;
    
    epn_block_subheader_line1 sub_line1;
 
    epn_block_subheader_line2 sub_line2;
 
    epn_data_block data;
 
    unsigned current_record;


    double centre_frequency;

    double bandwidth;

    Signal::State state;

    unsigned nsubint;

    virtual void set_nbin (unsigned numbins);

    virtual void set_nchan (unsigned numchan);

    virtual void set_npol (unsigned numpol);

    virtual void set_nsubint (unsigned nsubint);

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

    void init();

    void read_record (const char* filename, unsigned record);
 
  };
 
 
 
}
 
#endif