bpp::SimpleCommentable Class Reference

#include <Bpp/Seq/Commentable.h>

Inheritance diagram for bpp::SimpleCommentable:

Collaboration diagram for bpp::SimpleCommentable:

Public Member Functions
	SimpleCommentable ()
	SimpleCommentable (const Comments &comments)
	SimpleCommentable (const SimpleCommentable &com)
SimpleCommentable &	operator= (const SimpleCommentable &com)
virtual	~SimpleCommentable ()
const Comments &	getComments () const override
	Get the comments. More...
void	setComments (const Comments &comments) override
	Set the comments. More...
void	clearComments () override

Protected Attributes
Comments	comments_

Detailed Description

Definition at line 46 of file Commentable.h.

Constructor & Destructor Documentation

SimpleCommentable() [1/3]

bpp::SimpleCommentable::SimpleCommentable ( )

inline

Definition at line 53 of file Commentable.h.

SimpleCommentable() [2/3]

bpp::SimpleCommentable::SimpleCommentable ( const Comments &  comments )

inline

Definition at line 57 of file Commentable.h.

SimpleCommentable() [3/3]

bpp::SimpleCommentable::SimpleCommentable ( const SimpleCommentable &  com )

inline

Definition at line 61 of file Commentable.h.

~SimpleCommentable()

virtual bpp::SimpleCommentable::~SimpleCommentable ( )

inlinevirtual

Definition at line 71 of file Commentable.h.

Member Function Documentation

clearComments()

void bpp::SimpleCommentable::clearComments ( )

inlineoverridevirtual

Implements bpp::Commentable.

Definition at line 88 of file Commentable.h.

References comments_.

getComments()

const Comments& bpp::SimpleCommentable::getComments ( ) const

inlineoverridevirtual

Get the comments.

Returns

The comments.

Implements bpp::Commentable.

Definition at line 79 of file Commentable.h.

References comments_.

Referenced by bpp::SequenceWithQualityTools::concatenate(), bpp::TemplateAlignedSequenceContainer< SequenceType, SiteType >::createEmptyContainer(), bpp::CompressedVectorSiteContainer::createEmptyContainer(), bpp::TemplateVectorSequenceContainer< SequenceType >::createEmptyContainer(), bpp::TemplateVectorSiteContainer< SiteType, SequenceType >::createEmptyContainer(), bpp::SequenceWithAnnotationTools::createMaskAnnotation(), bpp::SequenceWithAnnotation::operator=(), bpp::SequenceWithQualityTools::subseq(), bpp::Pasta::writeSequence(), and bpp::Fasta::writeSequence().

operator=()

SimpleCommentable& bpp::SimpleCommentable::operator= ( const SimpleCommentable &  com )

inline

Definition at line 65 of file Commentable.h.

References comments_.

Referenced by bpp::AbstractCoreSequence::operator=(), and bpp::AbstractTemplateSequenceContainer< SequenceType, HashType >::operator=().

setComments()

void bpp::SimpleCommentable::setComments ( const Comments &  comments )

inlineoverridevirtual

Set the comments.

Parameters

comments

The new comments.

Implements bpp::Commentable.

Definition at line 86 of file Commentable.h.

References comments_.

Referenced by bpp::CompressedVectorSiteContainer::createEmptyContainer(), bpp::TemplateVectorSequenceContainer< SequenceType >::createEmptyContainer(), bpp::Pasta::nextSequence(), bpp::Fasta::nextSequence(), bpp::AbstractCoreSequence::operator=(), bpp::SequenceWithAnnotation::operator=(), bpp::AbstractTemplateSequenceContainer< SequenceType, HashType >::operator=(), bpp::TemplateVectorSequenceContainer< SequenceType >::operator=(), bpp::TemplateAlignedSequenceContainer< SequenceType, SiteType >::TemplateAlignedSequenceContainer(), and bpp::TemplateVectorSequenceContainer< SequenceType >::TemplateVectorSequenceContainer().

Member Data Documentation

comments_

Comments bpp::SimpleCommentable::comments_

protected

Definition at line 50 of file Commentable.h.

Referenced by clearComments(), getComments(), operator=(), and setComments().

---

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

• Bpp/Seq/Commentable.h