structure_file_reader.h

Go to the documentation of this file.

// -*- mode: c++; -*-
//
//The Biomolecule Toolkit (BTK) is a C++ library for use in the
//modeling, analysis, and design of biological macromolecules.
//Copyright (C) 2001, Tim Robertson <kid50@users.sourceforge.net>
//
//This program is free software; you can redistribute it and/or modify
//it under the terms of the GNU Lesser General Public License as published
//by the Free Software Foundation; either version 2.1 of the License, or (at
//your option) any later version.
//
//This program is distributed in the hope that it will be useful,  but
//WITHOUT ANY WARRANTY; without even the implied warranty of
//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//Lesser General Public License for more details. 
//
//You should have received a copy of the GNU Lesser General Public License 
//along with this program; if not, write to the Free Software Foundation, 
//Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

#ifndef STRUCTURE_FILE_READER_H
#define STRUCTURE_FILE_READER_H

#include <string>
#include <vector>
#include <exception>
#include <memory>
#include <iosfwd>

namespace BTK {

// Forward declaration(s).
class PDBAtom;
  
class StructureFileReader
{
  public:

  class StructureFileReadFailure : public std::exception
  {
  public:
    StructureFileReadFailure(char const * what = "");
    virtual char const * what() const throw();
  private:
    char const * _what;
  };

  typedef std::vector<PDBAtom> chain_type;

  StructureFileReader(std::string const & filename);

  StructureFileReader(std::istream & stream);
  
  virtual ~StructureFileReader() = 0;

  virtual std::string get_header() = 0;
  
  virtual std::vector<char> get_chain_ids() = 0;

  virtual std::auto_ptr<chain_type> get_chain(char const id = ' ') = 0;

  virtual std::auto_ptr<chain_type> get_next_chain() = 0;
  
  protected:

  std::istream & stream() { return *_stream; }

  private:
  std::istream *_stream;
  bool _locally_allocated;
  
  // Disallow default copy construction and assignment operator
  StructureFileReader(StructureFileReader const & source);
  StructureFileReader & operator=(StructureFileReader const & source);
};

// This typedef eliminates the potential hiding of class StructureFileReader
// with a function named StructureFileReader
typedef class StructureFileReader StructureFileReader;

} // namespace BTK

#endif // STRUCTURE_FILE_READER_H

---