BTK::StructureFileReader Class Reference

#include <structure_file_reader.h>

List of all members.

Public Types
typedef std::vector< PDBAtom >	chain_type
Public Member Functions
	StructureFileReader (std::string const &filename)
	StructureFileReader (std::istream &stream)
virtual	~StructureFileReader ()=0
	Virtual Destructor.
virtual std::string	get_header ()=0
	Get the header from the structure file, if any.
virtual std::vector< char >	get_chain_ids ()=0
	Get a vector of the chain IDs in the structure file.
virtual std::auto_ptr< chain_type >	get_chain (char const id= ' ')=0
virtual std::auto_ptr< chain_type >	get_next_chain ()=0
	Get the next chain (sequentially) from the structure file.
Protected Member Functions
std::istream &	stream ()
	Give direct access to the stream to derived classes.

---

Detailed Description

StructureFileReader abstract base class. This class provides an interface and basic stream implementation common to all biological structure file parsers. See the BTK::PDBReader class for an implementation of this interface (for parsing Brookhaven Protein Data Bank files).

---

Member Typedef Documentation

typedef std::vector<PDBAtom> BTK::StructureFileReader::chain_type

---

Constructor & Destructor Documentation

BTK::StructureFileReader::StructureFileReader (  std::string const &  filename  )

Open a new StructureFileReader.

BTK::StructureFileReader::StructureFileReader (  std::istream &  stream  )

Create a StructureFile from an input stream.

BTK::StructureFileReader::~StructureFileReader (   )  [pure virtual]

Virtual Destructor.

---

Member Function Documentation

virtual std::auto_ptr<chain_type> BTK::StructureFileReader::get_chain (  char const  id = ' '  )  [pure virtual]

Get a chain corresponding to a particular chain ID. If a chain ID is omitted, this method returns the first chain in the file.

virtual std::vector<char> BTK::StructureFileReader::get_chain_ids (   )  [pure virtual]

Get a vector of the chain IDs in the structure file.

virtual std::string BTK::StructureFileReader::get_header (   )  [pure virtual]

Get the header from the structure file, if any.

virtual std::auto_ptr<chain_type> BTK::StructureFileReader::get_next_chain (   )  [pure virtual]

Get the next chain (sequentially) from the structure file.

std::istream& BTK::StructureFileReader::stream (   )  [inline, protected]

Give direct access to the stream to derived classes.

---

The documentation for this class was generated from the following files:

• structure_file_reader.h
• structure_file_reader.cpp

---