bpp-seq  2.2.0
bpp::BppOSequenceWriterFormat Class Reference

Sequence I/O in BppO format. More...

#include <Bpp/Seq/Io/BppOSequenceWriterFormat.h>

+ Inheritance diagram for bpp::BppOSequenceWriterFormat:
+ Collaboration diagram for bpp::BppOSequenceWriterFormat:

Public Member Functions

 BppOSequenceWriterFormat (int warningLevel)
 
virtual ~BppOSequenceWriterFormat ()
 
const std::string getFormatName () const
 
const std::string getFormatDescription () const
 
const std::string getDataType () const
 
OSequenceread (const std::string &description) throw (Exception)
 Read a OSequence object from a string. More...
 
virtual const std::map< std::string, std::string > & getUnparsedArguments () const
 

Private Attributes

std::map< std::string, std::string > unparsedArguments_
 
int warningLevel_
 

Detailed Description

Sequence I/O in BppO format.

Creates a new OSequence object according to distribution description syntax (see the Bio++ Program Suite manual for a detailed description of this syntax).

Definition at line 56 of file BppOSequenceWriterFormat.h.

Constructor & Destructor Documentation

◆ BppOSequenceWriterFormat()

bpp::BppOSequenceWriterFormat::BppOSequenceWriterFormat ( int  warningLevel)
inline

Definition at line 64 of file BppOSequenceWriterFormat.h.

◆ ~BppOSequenceWriterFormat()

virtual bpp::BppOSequenceWriterFormat::~BppOSequenceWriterFormat ( )
inlinevirtual

Definition at line 66 of file BppOSequenceWriterFormat.h.

Member Function Documentation

◆ getDataType()

const std::string bpp::BppOSequenceWriterFormat::getDataType ( ) const
inline

Definition at line 73 of file BppOSequenceWriterFormat.h.

◆ getFormatDescription()

const std::string bpp::BppOSequenceWriterFormat::getFormatDescription ( ) const
inline

Definition at line 71 of file BppOSequenceWriterFormat.h.

◆ getFormatName()

const std::string bpp::BppOSequenceWriterFormat::getFormatName ( ) const
inline

Definition at line 69 of file BppOSequenceWriterFormat.h.

◆ getUnparsedArguments()

virtual const std::map<std::string, std::string>& bpp::BppOSequenceWriterFormat::getUnparsedArguments ( ) const
inlinevirtual
Returns
The arguments and their unparsed values from the last call of the read function, if there are any.

Definition at line 87 of file BppOSequenceWriterFormat.h.

References unparsedArguments_.

◆ read()

OSequence * BppOSequenceWriterFormat::read ( const std::string &  description)
throw (Exception
)

Read a OSequence object from a string.

Parameters
descriptionA string describing the reader in the keyval syntax.
Returns
A new OSequence object according to options specified.
Exceptions
Exceptionif an error occured.

Definition at line 52 of file BppOSequenceWriterFormat.cpp.

Referenced by bpp::SequenceApplicationTools::writeSequenceFile().

Member Data Documentation

◆ unparsedArguments_

std::map<std::string, std::string> bpp::BppOSequenceWriterFormat::unparsedArguments_
private

Definition at line 60 of file BppOSequenceWriterFormat.h.

Referenced by getUnparsedArguments().

◆ warningLevel_

int bpp::BppOSequenceWriterFormat::warningLevel_
private

Definition at line 61 of file BppOSequenceWriterFormat.h.


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