bpp-seq3  3.0.0
bpp::CoreSite Class Referenceabstract

The core site interface. More...

#include <Bpp/Seq/CoreSite.h>

+ Inheritance diagram for bpp::CoreSite:
+ Collaboration diagram for bpp::CoreSite:

Public Member Functions

virtual ~CoreSite ()
 
The Clonable interface
CoreSiteclone () const =0
 
Setting/getting the position of the site.
virtual int getPosition () const =0
 Get the position of this site. More...
 
virtual void setPosition (int position)=0
 Set the position of this site. More...
 

Detailed Description

The core site interface.

The core interface for sites manipulation. It is very similar to the CoreSequence interface (a site is a vertical sequence!). Sites have a 'position' attribute. This attribute stands for an index in an alignment, and may be used as a unique identifier, in the same manner that names identify sequence objects.

Definition at line 60 of file CoreSite.h.

Constructor & Destructor Documentation

◆ ~CoreSite()

virtual bpp::CoreSite::~CoreSite ( )
inlinevirtual

Definition at line 76 of file CoreSite.h.

Member Function Documentation

◆ clone()

CoreSite* bpp::CoreSite::clone ( ) const
pure virtual

◆ getPosition()

virtual int bpp::CoreSite::getPosition ( ) const
pure virtual

Get the position of this site.

Returns
The position of this site.

Implemented in bpp::AbstractCoreSite.

Referenced by bpp::AbstractCoreSite::operator=().

◆ setPosition()

virtual void bpp::CoreSite::setPosition ( int  position)
pure virtual

Set the position of this site.

Parameters
positionThe new position of the site.

Implemented in bpp::AbstractCoreSite.


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