ArchiveExtension.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2008 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/Base/Classes/Pulsar/ArchiveExtension.h
 
#ifndef __Pulsar_Archive_Extension_h
#define __Pulsar_Archive_Extension_h
 
#include "Pulsar/Archive.h"
#include "extutil.h"
 
namespace Pulsar
{
  class Archive::Extension : public Reference::Able
  {
  public:

    Extension (const char* name);

    virtual ~Extension ();
    
    virtual Extension* clone () const = 0;
    
    virtual TextInterface::Parser* get_interface () { return 0; }
    
    std::string get_extension_name () const;
    
    virtual std::string get_short_name () const;

    virtual bool has_data () const { return true; }

    virtual void resize (unsigned nsubint,
                         unsigned npol  = 0,
                         unsigned nchan = 0,
                         unsigned nbin  = 0) {}

    static Extension* factory (const std::string& name);

    template<typename T>
      class Interface : public TextInterface::To<T>
    {
      std::string get_interface_name() const
      { return this->instance->get_short_name(); }
    };

    virtual void frequency_append (Archive* to, const Archive* from)
    { /* do nothing */ }
    
  protected:
    
    std::string extension_name;
    
  };

  template<class T>
  const T* Archive::get () const
  {
    return get_ext<const T> (this, "Pulsar::Archive::get<Ext>", verbose > 2);
  }

  template<class T>
  T* Archive::get ()
  {
    return get_ext<T> (this, "Pulsar::Archive::get<Ext>", verbose > 2);
  }

  template<class T>
  bool Archive::has () const
  {
    return get_ext<const T> (this, "Pulsar::Archive::has<Ext>", false) != nullptr;
  }

  template<class T>
  T* Archive::getadd ()
  {
    T* ext = get<T>();
    if (ext)
      return ext;
 
    Reference::To<T> add_ext = new T;
    add_extension (add_ext);
    return add_ext;
  }
 
}
 
#endif