ExampleArchive.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2003 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/Base/Classes/Pulsar/ExampleArchive.h
 
#ifndef __ExampleArchive_h
#define __ExampleArchive_h
 
#include "Pulsar/BasicArchive.h"
#include "Pulsar/Agent.h"
 
namespace Pulsar {


  class ExampleArchive : public BasicArchive {
 
  public:
    
    ExampleArchive ();

    ExampleArchive (const ExampleArchive& archive);

    ~ExampleArchive ();

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

    void copy (const Archive& archive);

    ExampleArchive* clone () const;
 
  protected:

    virtual void load_header (const char* filename);

    virtual Integration*
    load_Integration (const char* filename, unsigned index);

    bool can_unload () const { return false; }

    virtual void unload_file (const char* filename) const;
 
    // Advocates the use of the ExampleArchive plugin
    class Agent;

    friend class Archive::Advocate<ExampleArchive>;
 
  private:

    void init ();
 
  };
 
 
  // Advocates the use of the ExampleArchive plugin
  class ExampleArchive::Agent : public Archive::Advocate<ExampleArchive> {
    
  public:
    
    Agent () { } 
    
    bool advocate (const char* filename);
    
    std::string get_name () { return "ExampleArchive"; }
    
    std::string get_description ();
    
  };
 
}
 
#endif