Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

FASTAFile Class Reference

#include <OpenMS/FORMAT/FASTAFile.h>

List of all members.


Detailed Description

This class serves for reading in FASTA files.

Public Types

typedef std::pair< String, StringFASTAEntry
 FASTA entry type (first is comment, second is sequence).
typedef std::vector< FASTAEntryFASTAType
 FASTA type (a sequence of FASTA entries).

Public Member Functions

 FASTAFile ()
 Copy constructor.
virtual ~FASTAFile ()
 Destructor.
void load (const String &filename, FASTAType &data) throw (Exception::FileNotFound,Exception::ParseError)
 loads a FASTA file given by 'filename' and stores the information in 'data'
void store (const String &filename, const FASTAType &data) const throw (Exception::UnableToCreateFile)
 stores the data given by 'data' at the file 'filename'

Member Typedef Documentation

typedef std::pair<String, String> FASTAEntry

FASTA entry type (first is comment, second is sequence).

The first String in the pair corresponds to the comment that is written after the > in the FASTA file and the second String in the pair corresponds to the sequence.

typedef std::vector< FASTAEntry > FASTAType

FASTA type (a sequence of FASTA entries).


Constructor & Destructor Documentation

FASTAFile (  ) 

Copy constructor.

virtual ~FASTAFile (  )  [virtual]

Destructor.


Member Function Documentation

void load ( const String filename,
FASTAType data 
) throw (Exception::FileNotFound,Exception::ParseError)

loads a FASTA file given by 'filename' and stores the information in 'data'

void store ( const String filename,
const FASTAType data 
) const throw (Exception::UnableToCreateFile)

stores the data given by 'data' at the file 'filename'


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:44 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1