File Coverage

Bio/Tools/Run/ParametersI.pm
Criterion Covered Total %
statement 6 10 60.0
branch n/a
condition n/a
subroutine 2 4 50.0
pod 2 2 100.0
total 10 16 62.5


line stmt bran cond sub pod time code
1             #
2             # BioPerl module for wrapping runtime parameters
3             #
4             # Please direct questions and support issues to
5             #
6             # Cared for by Chad Matsalla (bioinformatics1 at dieselwurks dot com)
7             #
8             # Copyright Chad Matsalla
9             #
10             # You may distribute this module under the same terms as perl itself
11              
12             # POD documentation - main docs before the code
13              
14             =head1 NAME
15              
16             Bio::Tools::Run::ParametersI - A Base object for the parameters used to run programs
17              
18             =head1 SYNOPSIS
19              
20             # do not use this object directly, it provides the following methods
21             # for its subclasses
22              
23             my $void = $obj->set_parameter("parameter_name","parameter_value");
24             my $value = $obj->get_parameter("parameter_name");
25              
26             =head1 DESCRIPTION
27              
28             This is a basic container to hold the parameters used to run a program.
29              
30             =head1 FEEDBACK
31              
32             =head2 Mailing Lists
33              
34             User feedback is an integral part of the evolution of this and other
35             Bioperl modules. Send your comments and suggestions preferably to
36             the Bioperl mailing list. Your participation is much appreciated.
37              
38             bioperl-l@bioperl.org - General discussion
39             http://bioperl.org/wiki/Mailing_lists - About the mailing lists
40              
41             =head2 Support
42              
43             Please direct usage questions or support issues to the mailing list:
44              
45             I
46              
47             rather than to the module maintainer directly. Many experienced and
48             reponsive experts will be able look at the problem and quickly
49             address it. Please include a thorough description of the problem
50             with code and data examples if at all possible.
51              
52             =head2 Reporting Bugs
53              
54             Report bugs to the Bioperl bug tracking system to help us keep track
55             of the bugs and their resolution. Bug reports can be submitted via the
56             web:
57              
58             https://github.com/bioperl/bioperl-live/issues
59              
60             =head1 AUTHOR - Chad Matsalla
61              
62             Email bioinformatics1 at dieselwurks dot com
63              
64             =head1 APPENDIX
65              
66             The rest of the documentation details each of the object methods.
67             Internal methods are usually preceded with a _
68              
69             =cut
70              
71              
72             # Let the code begin...
73              
74              
75             package Bio::Tools::Run::ParametersI;
76 29     29   129 use strict;
  29         29  
  29         770  
77              
78             # Object preamble - inherits from Bio::Root::Root
79              
80              
81 29     29   85 use base qw(Bio::Root::RootI);
  29         27  
  29         2943  
82              
83             =head2 get_parameter
84              
85             Title : get_parameter
86             Usage : $parameter_object->get_parameter($param_name);
87             Function: Get the value of a parameter named $param_name
88             Returns : A scalar that should be a string
89             Args : A scalar that should be a string
90              
91             =cut
92              
93             sub get_parameter {
94 0     0 1   my ($self,$arg) = @_;
95 0           $self->throw_not_implemented;
96             }
97              
98              
99             =head2 set_parameter
100              
101             Title : set_parameter
102             Usage : $parameter_object->set_parameter($param_name => $param_value);
103             Function: Set the value of a parameter named $param_name to $param_value
104             Returns : Void
105             Args : A hash containing name=>value pairs
106              
107             =cut
108              
109             sub set_parameter {
110 0     0 1   my ($self,$name,$value) = @_;
111 0           $self->throw_not_implemented;
112             }
113              
114              
115              
116             1;