|
0
|
1 =head1 LICENSE
|
|
|
2
|
|
|
3 Copyright (c) 1999-2012 The European Bioinformatics Institute and
|
|
|
4 Genome Research Limited. All rights reserved.
|
|
|
5
|
|
|
6 This software is distributed under a modified Apache license.
|
|
|
7 For license details, please see
|
|
|
8
|
|
|
9 http://www.ensembl.org/info/about/code_licence.html
|
|
|
10
|
|
|
11 =head1 CONTACT
|
|
|
12
|
|
|
13 Please email comments or questions to the public Ensembl
|
|
|
14 developers list at <dev@ensembl.org>.
|
|
|
15
|
|
|
16 Questions may also be sent to the Ensembl help desk at
|
|
|
17 <helpdesk@ensembl.org>.
|
|
|
18
|
|
|
19 =cut
|
|
|
20
|
|
|
21 # Ensembl module for Bio::EnsEMBL::Variation::Sample
|
|
|
22 #
|
|
|
23 # Copyright (c) 2005 Ensembl
|
|
|
24 #
|
|
|
25
|
|
|
26
|
|
|
27 =head1 NAME
|
|
|
28
|
|
|
29 Bio::EnsEMBL::Variation::Sample - An abstract base class to represent
|
|
|
30 Population, Individual or Strain
|
|
|
31
|
|
|
32
|
|
|
33 =head1 SYNOPSIS
|
|
|
34
|
|
|
35 Abstract class - should not be instantiated. Implementation of
|
|
|
36 abstract methods must be performed by subclasses.
|
|
|
37
|
|
|
38 =head1 DESCRIPTION
|
|
|
39
|
|
|
40 This is a base class representing population, individual and strain. This base
|
|
|
41 class is simply a way of merging similar concepts that should have the same ID
|
|
|
42
|
|
|
43
|
|
|
44 =head1 METHODS
|
|
|
45
|
|
|
46 =cut
|
|
|
47
|
|
|
48 use strict;
|
|
|
49 use warnings;
|
|
|
50
|
|
|
51 package Bio::EnsEMBL::Variation::Sample;
|
|
|
52
|
|
|
53 use Bio::EnsEMBL::Storable;
|
|
|
54 use Bio::EnsEMBL::Utils::Argument qw(rearrange);
|
|
|
55 use Bio::EnsEMBL::Utils::Exception qw(throw);
|
|
|
56
|
|
|
57 our @ISA = ('Bio::EnsEMBL::Storable');
|
|
|
58
|
|
|
59
|
|
|
60 =head2 name
|
|
|
61
|
|
|
62 Arg [1] : string $newval (optional)
|
|
|
63 The new value to set the name attribute to
|
|
|
64 Example : $name = $obj->name()
|
|
|
65 Description: Getter/Setter for the name attribute
|
|
|
66 Returntype : string
|
|
|
67 Exceptions : none
|
|
|
68 Caller : general
|
|
|
69 Status : At Risk
|
|
|
70
|
|
|
71 =cut
|
|
|
72
|
|
|
73 sub name{
|
|
|
74 my $self = shift;
|
|
|
75 return $self->{'name'} = shift if(@_);
|
|
|
76 return $self->{'name'};
|
|
|
77 }
|
|
|
78
|
|
|
79
|
|
|
80
|
|
|
81 =head2 description
|
|
|
82
|
|
|
83 Arg [1] : string $newval (optional)
|
|
|
84 The new value to set the description attribute to
|
|
|
85 Example : $description = $obj->description()
|
|
|
86 Description: Getter/Setter for the description attribute
|
|
|
87 Returntype : string
|
|
|
88 Exceptions : none
|
|
|
89 Caller : general
|
|
|
90 Status : At Risk
|
|
|
91
|
|
|
92 =cut
|
|
|
93
|
|
|
94 sub description{
|
|
|
95 my $self = shift;
|
|
|
96 return $self->{'description'} = shift if(@_);
|
|
|
97 return $self->{'description'};
|
|
|
98 }
|
|
|
99
|
|
|
100
|
|
|
101
|
|
|
102 =head2 size
|
|
|
103
|
|
|
104 Arg [1] : int $newval (optional)
|
|
|
105 The new value to set the size attribute to
|
|
|
106 Example : $size = $obj->size()
|
|
|
107 Description: Getter/Setter for the size attribute
|
|
|
108 Returntype : int
|
|
|
109 Exceptions : none
|
|
|
110 Caller : general
|
|
|
111 Status : At Risk
|
|
|
112
|
|
|
113 =cut
|
|
|
114
|
|
|
115 sub size{
|
|
|
116 my $self = shift;
|
|
|
117 return $self->{'size'} = shift if(@_);
|
|
|
118 return $self->{'size'};
|
|
|
119 }
|
|
|
120
|
|
|
121
|
|
|
122 1;
|
