bpp::Commentable Class Reference

#include <Bpp/Seq/Commentable.h>

Inheritance diagram for bpp::Commentable:

Public Member Functions
	Commentable ()
virtual	~Commentable ()
virtual const Comments &	getComments () const =0
	Get the comments. More...
virtual void	setComments (const Comments &comments)=0
	Set the comments. More...
virtual void	clearComments ()=0

Detailed Description

Definition at line 23 of file Commentable.h.

Constructor & Destructor Documentation

Commentable()

bpp::Commentable::Commentable ( )

inline

Definition at line 26 of file Commentable.h.

~Commentable()

virtual bpp::Commentable::~Commentable ( )

inlinevirtual

Definition at line 27 of file Commentable.h.

Member Function Documentation

clearComments()

virtual void bpp::Commentable::clearComments ( )

pure virtual

Implemented in bpp::SimpleCommentable.

getComments()

virtual const Comments& bpp::Commentable::getComments ( ) const

pure virtual

Get the comments.

Returns

The comments.

Implemented in bpp::SimpleCommentable.

Referenced by bpp::Mase::appendSequencesFromStream(), bpp::AllelicAlphabet::convertFromStateAlphabet(), bpp::SiteContainerTools::getSelectedPositions(), bpp::MaseTools::getSelectedSites(), bpp::SiteContainerTools::getSelectedSites(), bpp::AbstractCoreSequence::operator=(), bpp::AbstractTemplateSequenceContainer< SequenceType, HashType >::operator=(), bpp::TemplateVectorSequenceContainer< SequenceType >::operator=(), bpp::SiteContainerTools::resolveDottedAlignment(), bpp::NucleicAcidsReplication::reverse(), bpp::AbstractReverseTransliterator::reverse(), bpp::SequenceTools::RNYslice(), bpp::SequenceTools::subseq(), bpp::TemplateAlignedSequenceContainer< SequenceType, SiteType >::TemplateAlignedSequenceContainer(), bpp::TemplateVectorSequenceContainer< SequenceType >::TemplateVectorSequenceContainer(), bpp::NucleicAcidsReplication::translate(), bpp::AbstractTransliterator::translate(), bpp::Stockholm::writeAlignment(), bpp::Fasta::writeSequences(), and bpp::Mase::writeSequences().

setComments()

virtual void bpp::Commentable::setComments ( const Comments &  comments )

pure virtual

Set the comments.

Parameters

comments

The new comments.

Implemented in bpp::SimpleCommentable.

Referenced by bpp::Pasta::appendAlignmentFromStream(), bpp::Clustal::appendAlignmentFromStream(), bpp::Fasta::appendSequencesFromStream(), and bpp::Mase::appendSequencesFromStream().

---

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

• Bpp/Seq/Commentable.h