PhaseSeriesUnloader.h

 
/***************************************************************************
 *
 *   Copyright (C) 2003-2009 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
//-*-C++-*-
 
// dspsr/Signal/Pulsar/dsp/PhaseSeriesUnloader.h
 
#ifndef __PhaseSeriesUnloader_h
#define __PhaseSeriesUnloader_h
 
#include "OwnStream.h"
#include "Reference.h"
 
namespace dsp {
 
  class PhaseSeries;
  class Operation;
  class FilenameConvention;
 
  class PhaseSeriesUnloader : public OwnStream
  {
 
  public:
    
    PhaseSeriesUnloader ();
    
    virtual ~PhaseSeriesUnloader ();
 
    virtual PhaseSeriesUnloader* clone () const = 0;
 
    virtual void unload (const PhaseSeries*) = 0;
 
    virtual void partial (const PhaseSeries*);
 
    virtual PhaseSeries* recycle () { return 0; }
 
    virtual void finish ();
 
    virtual std::string get_filename (const PhaseSeries* data) const;
 
    virtual void set_convention (FilenameConvention*);
    virtual FilenameConvention* get_convention ();
 
    virtual void set_directory (const std::string&);
    virtual std::string get_directory () const;
    
    virtual void set_path_add_source (bool);
    virtual bool get_path_add_source () const;
 
    virtual void set_prefix (const std::string&);
    virtual std::string get_prefix () const;
 
    virtual void set_extension (const std::string&);
    virtual std::string get_extension () const;
 
    virtual void set_minimum_integration_length (double seconds) = 0;
 
  protected:
 
    Reference::To<FilenameConvention> convention;
 
    std::string directory;
 
    std::string prefix;
 
    std::string extension;
 
    bool path_add_source;
 
  };
 
  class FilenameConvention : public Reference::Able
  {
  public:
    virtual std::string get_filename (const PhaseSeries* data) = 0;
  };
 
  class FilenameEpoch : public FilenameConvention
  {
  public:
    FilenameEpoch ();
    void set_datestr_pattern (const std::string&);
    void set_integer_seconds (unsigned);
    std::string get_filename (const PhaseSeries* data);
 
    bool report_unload;
 
  protected:
    std::string datestr_pattern;
    unsigned integer_seconds;
  };
 
  class FilenamePulse : public FilenameConvention
  {
  public:
    std::string get_filename (const PhaseSeries* data);
  };
 
  class FilenameSequential : public FilenameConvention
  {
  public:
    FilenameSequential();
    void set_base_filename (const std::string& s) { filename_base = s; }
    void set_index (unsigned idx) { current_index = idx; }
    unsigned get_index () const {  return current_index; }
    std::string get_filename (const PhaseSeries* data);
  protected:
    std::string filename_base;
    unsigned current_index;
  };
 
  class FilenameMJD : public FilenameConvention
  {
  public:
    FilenameMJD (unsigned digits);
    void set_base_filename (const std::string& s) { filename_base = s; }
    std::string get_filename (const PhaseSeries* data);
  protected:
    std::string filename_base;
    unsigned digits;
  };
 
}
 
#endif // !defined(__PhaseSeriesUnloader_h)