Genome< GENOME_TYPE > Class Template Reference

#include <genome.h>

List of all members.

Public Member Functions
	Genome ()
	~Genome ()
GENOME_TYPE	GetGenomeLen () const
void	SetGenomeLen (GENOME_TYPE len)
bool	IsGenomeCircular () const
void	SetGenomeCircular (bool circ)
string	GetGenomeName () const
void	SetGenomeName (const string name)
Genome &	operator= (const Genome &gen)
Private Attributes
GENOME_TYPE	GenomeLen
bool	Circular
string	GenomeName

---

Detailed Description

template<class GENOME_TYPE>
class Genome< GENOME_TYPE >

Class name: Genome

This class holds the information of a genome, which are: 1) The genome's name. 2) The genome's length. 3) An indicator of the genum's circularity.

Author:

Rani Zand

---

Constructor & Destructor Documentation

template<class GENOME_TYPE> Genome< GENOME_TYPE >::Genome (   )  [inline]

Constructor.

template<class GENOME_TYPE> Genome< GENOME_TYPE >::~Genome (   )  [inline]

Distructor.

---

Member Function Documentation

template<class GENOME_TYPE> GENOME_TYPE Genome< GENOME_TYPE >::GetGenomeLen (   )  const

Return the length of the genome in nucleotides. Parameters: @return  the length of the genome.

template<class GENOME_TYPE> string Genome< GENOME_TYPE >::GetGenomeName (   )  const

Return the genome's name. Returns: the genome's name.

template<class GENOME_TYPE> bool Genome< GENOME_TYPE >::IsGenomeCircular (   )  const

Return true if the genome is circular. Returns: true if the genome is circular.

template<class GENOME_TYPE> Genome< GENOME_TYPE > & Genome< GENOME_TYPE >::operator= (  const Genome< GENOME_TYPE > &  gen  )

operator =, copys all field to the given Genome .

template<class GENOME_TYPE> void Genome< GENOME_TYPE >::SetGenomeCircular (  bool  circ  )

Sets the genome's circularity. Parameters: circ  the new genome's circularity.

template<class GENOME_TYPE> void Genome< GENOME_TYPE >::SetGenomeLen (  GENOME_TYPE  len  )

Sets the genome's length in nucleotides. Parameters: len  the new genome's length.

template<class GENOME_TYPE> void Genome< GENOME_TYPE >::SetGenomeName (  const string  name  )

Sets the genome's name. Parameters: name  the new genome's name.

---

Member Data Documentation

template<class GENOME_TYPE> bool Genome< GENOME_TYPE >::Circular [private]

equals 'true' if the genome is circular, 'false' if not.

template<class GENOME_TYPE> GENOME_TYPE Genome< GENOME_TYPE >::GenomeLen [private]

The length of the genome in in nucleotides.

template<class GENOME_TYPE> string Genome< GENOME_TYPE >::GenomeName [private]

The name of the genome.

---

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

• Desktop/temp/stam/genome.h

---