bpp::AlleleInfo Class Reference

The AlleleInfo interface. More...

#include <Bpp/PopGen/AlleleInfo.h>

Inheritance diagram for bpp::AlleleInfo:

Collaboration diagram for bpp::AlleleInfo:

Public Member Functions
virtual	~AlleleInfo ()
virtual void	setId (const std::string &allele_id)=0
	Set the identifier of the allele. More...
virtual const std::string &	getId () const =0
	Get the identitier of the allele. More...
The Clonable interface
AlleleInfo *	clone () const =0

Detailed Description

The AlleleInfo interface.

An AlleleInfo is a data structure designed to store information about alleles in general like the size of the marker for example.

Author

Sylvain Gaillard

Definition at line 23 of file AlleleInfo.h.

Constructor & Destructor Documentation

~AlleleInfo()

virtual bpp::AlleleInfo::~AlleleInfo ( )

inlinevirtual

Definition at line 28 of file AlleleInfo.h.

Member Function Documentation

clone()

AlleleInfo* bpp::AlleleInfo::clone ( ) const

pure virtual

Implements bpp::Clonable.

Implemented in bpp::BasicAlleleInfo.

Referenced by bpp::LocusInfo::addAlleleInfo(), bpp::LocusInfo::LocusInfo(), and bpp::LocusInfo::operator=().

getId()

virtual const std::string& bpp::AlleleInfo::getId ( ) const

pure virtual

Get the identitier of the allele.

Implemented in bpp::BasicAlleleInfo.

Referenced by bpp::LocusInfo::addAlleleInfo(), bpp::DarwinVarSingle::write(), and bpp::PopgenlibIO::write().

setId()

virtual void bpp::AlleleInfo::setId ( const std::string &  allele_id )

pure virtual

Set the identifier of the allele.

Implemented in bpp::BasicAlleleInfo.

---

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

• Bpp/PopGen/AlleleInfo.h