Bio::Tools::Run ParametersI
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Toolbar
WebCvs
Summary
Bio::Tools::Run::ParametersI - A Base object for the parameters used to run programs
Package variables
No package variables defined.
Inherit
Bio::Root::RootI
Synopsis
  # do not use this object directly, it provides the following methods
# for its subclasses
my $void = $obj->set_parameter("parameter_name","parameter_value"); my $value = $obj->get_parameter("parameter_name");
Description
This is a basic container to hold the parameters used to run a program.
Methods
get_parameterDescriptionCode
set_parameterDescriptionCode
Methods description
get_parametercode    nextTop
 Title   : get_parameter
Usage : $parameter_object->get_parameter($param_name);
Function: Get the value of a parameter named $param_name
Returns : A scalar that should be a string
Args : A scalar that should be a string
set_parametercodeprevnextTop
 Title   : set_parameter
Usage : $parameter_object->set_parameter($param_name => $param_value);
Function: Set the value of a parameter named $param_name to $param_value
Returns : Void
Args : A hash containing name=>value pairs
Methods code
get_parameterdescriptionprevnextTop
sub get_parameter {
   my ($self,$arg) = @_;
     $self->throw_not_implemented;
}
set_parameterdescriptionprevnextTop
sub set_parameter {
   my ($self,$name,$value) = @_;
     $self->throw_not_implemented;
}



1;
}
General documentation
FEEDBACKTop
Mailing ListsTop
User feedback is an integral part of the evolution of this and other
Bioperl modules. Send your comments and suggestions preferably to
the Bioperl mailing list. Your participation is much appreciated.
  bioperl-l@bioperl.org                  - General discussion
http://bioperl.org/wiki/Mailing_lists - About the mailing lists
Support Top
Please direct usage questions or support issues to the mailing list:
bioperl-l@bioperl.org
rather than to the module maintainer directly. Many experienced and
reponsive experts will be able look at the problem and quickly
address it. Please include a thorough description of the problem
with code and data examples if at all possible.
Reporting BugsTop
Report bugs to the Bioperl bug tracking system to help us keep track
of the bugs and their resolution. Bug reports can be submitted via the
web:
  https://redmine.open-bio.org/projects/bioperl/
AUTHOR - Chad MatsallaTop
Email bioinformatics1 at dieselwurks dot com
APPENDIXTop
The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _