NAME

Bio::Phylo::Taxa::TaxonLinker - Superclass for objects that link to taxon objects.

SYNOPSIS

use Bio::Phylo::Forest::Node;
use Bio::Phylo::Taxa::Taxon;

my $node  = Bio::Phylo::Forest::Node->new;
my $taxon = Bio::Phylo::Taxa::Taxon->new;

# just to show who's what
if ( $node->isa('Bio::Phylo::Taxa::TaxonLinker') ) { 
   $node->set_taxon( $taxon );
}

# prints 'Bio::Phylo::Taxa::Taxon'
print ref $node->get_taxon 

DESCRIPTION

This module is a superclass for objects that link to Bio::Phylo::Taxa::Taxon objects.

METHODS

MUTATORS

set_taxon()

Links the invocant object to a taxon object.

Type    : Mutator
Title   : set_taxon
Usage   : $obj->set_taxon( $taxon );
Function: Links the invocant object
          to a taxon object.
Returns : Modified $obj
Args    : A Bio::Phylo::Taxa::Taxon object.

unset_taxon()

Unlinks the invocant object from any taxon object.

Type    : Mutator
Title   : unset_taxon
Usage   : $obj->unset_taxon();
Function: Unlinks the invocant object
          from any taxon object.
Returns : Modified $obj
Args    : NONE

ACCESSORS

get_taxon()

Retrieves the Bio::Phylo::Taxa::Taxon object linked to the invocant.

Type    : Accessor
Title   : get_taxon
Usage   : my $taxon = $obj->get_taxon;
Function: Retrieves the Bio::Phylo::Taxa::Taxon
          object linked to the invocant.
Returns : Bio::Phylo::Taxa::Taxon
Args    : NONE
Comments:

SEE ALSO

Bio::Phylo::Matrices::Datum

The datum object subclasses Bio::Phylo::Taxa::TaxonLinker.

Bio::Phylo::Forest::Node

The node object subclasses Bio::Phylo::Taxa::TaxonLinker.

Bio::Phylo::Manual

Also see the manual: Bio::Phylo::Manual.

REVISION

$Id: TaxonLinker.pm 4251 2007-07-19 14:21:33Z rvosa $