lib/Bio/GeneticRelationships/Descendants.pm

   1 package Bio::GeneticRelationships::Descendants;
   2 use strict;
   3 use warnings;
   4
   5 use Moose;
   6 use MooseX::FollowPBP;
   7 use Moose::Util::TypeConstraints;
   8 use Bio::GeneticRelationships::Individual;
   9
  10 =head1 NAME
  11
  12     Bio::GeneticRelationships::Descendants - Descendants of an individual
  13
  14 =head1 SYNOPSIS
  15
  16     my $variable = Bio::GeneticRelationships::Descendants->new();
  17
  18 =head1 DESCRIPTION
  19
  20     This class stores an individual's descendants and their relationships.
  21
  22 =head2 Methods
  23
  24 =over
  25
  26 =cut
  27
  28
  29
  30
  31 has 'name' => (isa => 'Str',is => 'rw', predicate => 'has_name', required => 1,);
  32 has 'offspring' => (isa => 'ArrayRef[Bio::GeneticRelationships::Individual]', is => 'rw', predicate => 'has_offspring');
  33
  34 #change to hash????
  35 sub add_offspring {
  36     my $self = shift;
  37     my $offspring_to_add = shift;
  38     my @offspring_array;
  39     if ($self->has_offspring()){
  40         @offspring_array = @{$self->get_offspring()};
  41     }
  42     push (@offspring_array, $offspring_to_add);
  43     $self->set_offspring([@offspring_array]);
  44 }
  45
  46
  47 ###
  48 1;#do not remove
  49 ###
  50
  51 =pod
  52
  53 =back
  54
  55 =head1 LICENSE
  56
  57     Same as Perl.
  58
  59 =head1 AUTHORS
  60
  61     Jeremy D. Edwards <jde22@cornell.edu>
  62
  63 =cut