Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Classes | Public Member Functions

FASTAFile Class Reference

This class serves for reading in FASTA files. More...

#include <OpenMS/FORMAT/FASTAFile.h>

List of all members.

Classes

struct  FASTAEntry
 FASTA entry type (identifier, description and sequence). More...

Public Member Functions

 FASTAFile ()
 Copy constructor.
virtual ~FASTAFile ()
 Destructor.
void load (const String &filename, std::vector< FASTAEntry > &data)
 loads a FASTA file given by 'filename' and stores the information in 'data'
void store (const String &filename, const std::vector< FASTAEntry > &data) const
 stores the data given by 'data' at the file 'filename'

Detailed Description

This class serves for reading in FASTA files.


Constructor & Destructor Documentation

FASTAFile (  ) 

Copy constructor.

virtual ~FASTAFile (  )  [virtual]

Destructor.


Member Function Documentation

void load ( const String filename,
std::vector< FASTAEntry > &  data 
)

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

Exceptions:
Exception::FileNotFound is thrown if the file does not exists.
Exception::ParseError is thrown if the file does not suit to the standard.
void store ( const String filename,
const std::vector< FASTAEntry > &  data 
) const

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

Exceptions:
Exception::UnableToCreateFile is thrown if the process is not able to write the file.

OpenMS / TOPP release 1.10.0 Documentation generated on Thu Mar 7 2013 09:42:53 using doxygen 1.7.1