← Back to branch summary

~ubuntu-branches/ubuntu/precise/bioperl/precise

« back to all changes in this revision

Viewing changes to Bio/Search/StatisticsI.pm

  • Committer: Bazaar Package Importer
  • Author(s): Charles Plessy
  • Date: 2007-09-21 22:52:22 UTC
  • mfrom: (1.2.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20070921225222-tt20m2yy6ycuy2d8
Tags: 1.5.2.102-1
* Developer release.
* Upgraded source package to debhelper 5 and standards-version 3.7.2.
* Added libmodule-build-perl and libtest-harness-perl to
  build-depends-indep.
* Disabled automatic CRAN download.
* Using quilt instead of .diff.gz to manage modifications.
* Updated Recommends list for the binary package.
* Moved the "production-quality" scripts to /usr/bin/.
* New maintainer: Debian-Med packaging team mailing list.
* New uploaders: Charles Plessy and Steffen Moeller.
* Updated Depends, Recommends and Suggests.
* Imported in Debian-Med's SVN repository on Alioth.
* Executing the regression tests during package building.
* Moved the Homepage: field out from the package's description.
* Updated watch file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
Bio/Search/StatisticsI.pm
 
1
# 
 
2
#
 
3
# BioPerl module for wrapping runtime parameters
 
4
#
 
5
# Cared for by Chad Matsalla (bioinformatics1 at dieselwurks dot com)
 
6
#
 
7
# Copyright Chad Matsalla
 
8
#
 
9
# You may distribute this module under the same terms as perl itself
 
10
 
 
11
# POD documentation - main docs before the code
 
12
 
 
13
=head1 NAME
 
14
 
 
15
Bio::Search::StatisticsI - A Base object for statistics
 
16
 
 
17
=head1 SYNOPSIS
 
18
 
 
19
  # do not use this object directly, it provides the following methods
 
20
  # for its subclasses
 
21
 
 
22
  my $void   = $obj->set_statistic("statistic_name","statistic_value"); 
 
23
  my $value  = $obj->get_statistic("statistic_name");
 
24
 
 
25
=head1 DESCRIPTION
 
26
 
 
27
This is a basic container to hold the statistics returned from a program.
 
28
 
 
29
=head1 FEEDBACK
 
30
 
 
31
=head2 Mailing Lists
 
32
 
 
33
User feedback is an integral part of the evolution of this and other
 
34
Bioperl modules. Send your comments and suggestions preferably to
 
35
the Bioperl mailing list.  Your participation is much appreciated.
 
36
 
 
37
  bioperl-l@bioperl.org                  - General discussion
 
38
  http://bioperl.org/wiki/Mailing_lists  - About the mailing lists
 
39
 
 
40
=head2 Reporting Bugs
 
41
 
 
42
Report bugs to the Bioperl bug tracking system to help us keep track
 
43
of the bugs and their resolution. Bug reports can be submitted via the
 
44
web:
 
45
 
 
46
  http://bugzilla.open-bio.org/
 
47
 
 
48
=head1 AUTHOR - Chad Matsalla
 
49
 
 
50
Email bioinformatics1 at dieselwurks dot com
 
51
 
 
52
=head1 APPENDIX
 
53
 
 
54
The rest of the documentation details each of the object methods.
 
55
Internal methods are usually preceded with a _
 
56
 
 
57
=cut
 
58
 
 
59
 
 
60
# Let the code begin...
 
61
 
 
62
 
 
63
package Bio::Search::StatisticsI;
 
64
use strict;
 
65
 
 
66
# Object preamble - inherits from Bio::Root::Root
 
67
 
 
68
 
 
69
use base qw(Bio::Root::RootI);
 
70
 
 
71
 
 
72
=head2 get_statistic
 
73
 
 
74
 Title   : get_statistic
 
75
 Usage   : $statistic_object->get_statistic($statistic_name);
 
76
 Function: Get the value of a statistic named $statistic_name
 
77
 Returns : A scalar that should be a string
 
78
 Args    : A scalar that should be a string
 
79
 
 
80
=cut
 
81
 
 
82
sub get_statistic {
 
83
   my ($self,$arg) = @_;
 
84
     $self->throw_not_implemented;
 
85
}
 
86
 
 
87
 
 
88
=head2 set_statistic
 
89
 
 
90
 Title   : set_statistic
 
91
 Usage   : $statistic_object->set_statistic($statistic_name => $statistic_value);
 
92
 Function: Set the value of a statistic named $statistic_name to $statistic_value
 
93
 Returns : Void
 
94
 Args    : A hash containing name=>value pairs
 
95
 
 
96
=cut
 
97
 
 
98
sub set_statistic {
 
99
   my ($self,$name,$value) = @_;
 
100
     $self->throw_not_implemented;
 
101
}
 
102
 
 
103
 
 
104
 
 
105
1;