TTNeutralGenes Class Reference

Abstract base class for neutral gene traits. More...

#include <ttneutralgenes.h>

Inheritance diagram for TTNeutralGenes:

Collaboration diagram for TTNeutralGenes:

Public Member Functions
	TTNeutralGenes ()
	TTNeutralGenes (const TTNeutralGenes &T)
virtual	~TTNeutralGenes ()
Accessors
void	set_proto (TProtoNeutralGenes *proto)
Implementations
virtual TTNeutralGenes &	operator= (const TTrait &T)=0
virtual bool	operator== (const TTrait &T)
virtual bool	operator!= (const TTrait &T)
virtual void	init ()=0
virtual void	init_sequence ()=0
virtual void	reset ()=0
virtual void *	set_trait (void *value)
virtual void **	get_sequence () const =0
virtual unsigned int	get_allele (int loc, int all) const =0
virtual double	get_allele_value (int loc, int all) const =0
virtual void	set_allele_value (unsigned int locus, unsigned int allele, double value)=0
virtual void	set_sequence (void **seq)=0
virtual trait_t	get_type () const
virtual void	set_value ()
virtual void *	getValue () const
virtual void	inherit (const TTrait *mother, const TTrait *father)=0
virtual void	mutate ()=0
virtual void	show_up ()=0
virtual TTNeutralGenes *	clone ()=0
virtual void	store_data (BinaryStorageBuffer *saver)=0
virtual bool	retrieve_data (BinaryStorageBuffer *reader)=0
Public Member Functions inherited from TTrait
virtual	~TTrait ()
Public Member Functions inherited from StorableComponent
virtual	~StorableComponent ()

Protected Attributes
TProtoNeutralGenes *	_myProto
const trait_t	_type

Detailed Description

Abstract base class for neutral gene traits.

Constructor & Destructor Documentation

TTNeutralGenes() [1/2]

TTNeutralGenes::TTNeutralGenes ( )

inline

    : _myProto(0), _type(NTRL) { }

TTNeutralGenes() [2/2]

TTNeutralGenes::TTNeutralGenes ( const TTNeutralGenes &  T )

inline

    : _myProto(T._myProto), _type(NTRL) { }

~TTNeutralGenes()

virtual TTNeutralGenes::~TTNeutralGenes ( )

inlinevirtual

{}

Member Function Documentation

clone()

virtual TTNeutralGenes* TTNeutralGenes::clone ( )

pure virtual

Implements TTrait.

Implemented in TTNeutralGenes_bitstring, and TTNeutralGenes_byte.

get_allele()

virtual unsigned int TTNeutralGenes::get_allele ( int  loc, int  all  ) const

pure virtual

Implements TTrait.

Implemented in TTNeutralGenes_bitstring, and TTNeutralGenes_byte.

get_allele_value()

virtual double TTNeutralGenes::get_allele_value ( int  loc, int  all  ) const

pure virtual

Implements TTrait.

Implemented in TTNeutralGenes_bitstring, and TTNeutralGenes_byte.

get_sequence()

virtual void** TTNeutralGenes::get_sequence ( ) const

pure virtual

Implements TTrait.

Implemented in TTNeutralGenes_bitstring, and TTNeutralGenes_byte.

get_type()

virtual trait_t TTNeutralGenes::get_type ( ) const

inlinevirtual

Implements TTrait.

{return _type;}

References _type.

getValue()

virtual void* TTNeutralGenes::getValue ( ) const

inlinevirtual

Implements TTrait.

{return 0;}

inherit()

virtual void TTNeutralGenes::inherit ( const TTrait *  mother, const TTrait *  father  )

pure virtual

Implements TTrait.

Implemented in TTNeutralGenes_bitstring, and TTNeutralGenes_byte.

init()

virtual void TTNeutralGenes::init ( )

pure virtual

Implements TTrait.

Implemented in TTNeutralGenes_bitstring, and TTNeutralGenes_byte.

init_sequence()

virtual void TTNeutralGenes::init_sequence ( )

pure virtual

Implements TTrait.

Implemented in TTNeutralGenes_bitstring, and TTNeutralGenes_byte.

mutate()

virtual void TTNeutralGenes::mutate ( )

pure virtual

Implements TTrait.

Implemented in TTNeutralGenes_bitstring, and TTNeutralGenes_byte.

operator!=()

bool TTNeutralGenes::operator!= ( const TTrait &  T )

virtual

Implements TTrait.

    {
  if(!((*this) == T))
    return true;
  else
    return false;
    }

operator=()

virtual TTNeutralGenes& TTNeutralGenes::operator= ( const TTrait &  T )

pure virtual

Implements TTrait.

Implemented in TTNeutralGenes_bitstring, and TTNeutralGenes_byte.

operator==()

bool TTNeutralGenes::operator== ( const TTrait &  T )

virtual

Implements TTrait.

    {
  if(_type.compare(T.get_type()) != 0) return false;
  const TTNeutralGenes& TN = dynamic_cast<const TTNeutralGenes&> (T);
 
  if(this != &TN) {
    if(_myProto->get_locus_num() != TN._myProto->get_locus_num()) return false;
    if(_myProto->get_allele_num() != TN._myProto->get_allele_num()) return false;
    if(_myProto->get_ploidy() != TN._myProto->get_ploidy()) return false;
  }
  return true;
    }

References _myProto, _type, TProtoNeutralGenes::get_allele_num(), TProtoNeutralGenes::get_locus_num(), TProtoNeutralGenes::get_ploidy(), and TTrait::get_type().

reset()

virtual void TTNeutralGenes::reset ( )

pure virtual

Implements TTrait.

Implemented in TTNeutralGenes_bitstring, and TTNeutralGenes_byte.

retrieve_data()

virtual bool TTNeutralGenes::retrieve_data ( BinaryStorageBuffer *  reader )

pure virtual

Implements StorableComponent.

Implemented in TTNeutralGenes_bitstring, and TTNeutralGenes_byte.

set_allele_value()

virtual void TTNeutralGenes::set_allele_value ( unsigned int  locus, unsigned int  allele, double  value  )

pure virtual

Implements TTrait.

Implemented in TTNeutralGenes_bitstring, and TTNeutralGenes_byte.

set_proto()

void TTNeutralGenes::set_proto ( TProtoNeutralGenes *  proto )

inline

{_myProto = proto;}

References _myProto.

Referenced by TProtoNeutralGenes::hatch().

set_sequence()

virtual void TTNeutralGenes::set_sequence ( void **  seq )

pure virtual

Implements TTrait.

Implemented in TTNeutralGenes_bitstring, and TTNeutralGenes_byte.

set_trait()

virtual void* TTNeutralGenes::set_trait ( void *  value )

inlinevirtual

Implements TTrait.

{return NULL;}

set_value()

virtual void TTNeutralGenes::set_value ( )

inlinevirtual

Implements TTrait.

{ }

show_up()

virtual void TTNeutralGenes::show_up ( )

pure virtual

Implements TTrait.

Implemented in TTNeutralGenes_bitstring, and TTNeutralGenes_byte.

store_data()

virtual void TTNeutralGenes::store_data ( BinaryStorageBuffer *  saver )

pure virtual

Implements StorableComponent.

Implemented in TTNeutralGenes_bitstring, and TTNeutralGenes_byte.

Member Data Documentation

_myProto

TProtoNeutralGenes* TTNeutralGenes::_myProto

protected

Referenced by TTNeutralGenes_byte::get_allele(), TTNeutralGenes_byte::get_allele_value(), TTNeutralGenes_byte::inherit(), TTNeutralGenes_byte::init(), TTNeutralGenes_byte::init_sequence(), TTNeutralGenes_byte::mutate_2all(), TTNeutralGenes_byte::mutate_KAM(), TTNeutralGenes_byte::mutate_SSM(), TTNeutralGenes_byte::operator=(), TTNeutralGenes_bitstring::operator=(), operator==(), TTNeutralGenes_byte::reset(), TTNeutralGenes_byte::retrieve_data(), set_proto(), TTNeutralGenes_byte::set_sequence(), TTNeutralGenes_byte::show_up(), TTNeutralGenes_byte::store_data(), and TTNeutralGenes_byte::~TTNeutralGenes_byte().

_type

const trait_t TTNeutralGenes::_type

protected

Referenced by get_type(), and operator==().

---

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

• ttneutralgenes.h
• ttneutralgenes.cc