Bio::Phylo::Taxa::TaxonLinker(3)

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

SYNOPSIS
 use Bio::Phylo::Factory;
 my $fac = Bio::Phylo::Factory->new;

 my $node  = $fac->create_node;
 my $taxon = $fac->create_taxon;

 # 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
There is a mailing list at <https://groups.google.com/forum/#!forum/bio-phylo> for any user or developer questions and discussions.

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 and <http://rutgervos.blogspot.com>.

CITATION
If you use Bio::Phylo in published research, please cite it:

Rutger A Vos, Jason Caravas, Klaas Hartmann, Mark A Jensen and Chase Miller, 2011. Bio::Phylo - phyloinformatic analysis using Perl. BMC Bioinformatics 12:63. <http://dx.doi.org/10.1186/1471-2105-12-63>