Bio::Tools::Run GenericParameters
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Summary
Bio::Tools::Run::GenericParameters - An object for the parameters used to run programs
Package variables
No package variables defined.
Inherit
Bio::Root::Root Bio::Tools::Run::ParametersI
Synopsis
  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. This module may get incorporated into the more generic
Bio::Tools::Run framework in bioperl-run distribution.
Methods
new
No description
Code
get_parameterDescriptionCode
set_parameterDescriptionCode
available_parametersDescriptionCode
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
available_parameterscodeprevnextTop
 Title   : available_parameters
 Usage   : my @paramnames = $parameter_object->available_parameters
 Function: Returns the names of the available parameters
 Returns : list of available parameter names
 Args    : none
Methods code
newdescriptionprevnextTop
sub new {
    my ($class, @args) = @_;
    my $self = $class->SUPER::new(@args);
    return $self;
}
get_parameterdescriptionprevnextTop
sub get_parameter {
    my ($self,$arg) = @_;
    return $self->{params}->{$arg};
}
set_parameterdescriptionprevnextTop
sub set_parameter {
    my ($self,$name,$value) = @_;
    $self->{params}->{$name} = $value;
}
available_parametersdescriptionprevnextTop
sub available_parameters {
    my $self = shift;
    return keys %{$self->{params}};
}

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
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:
  http://bugzilla.open-bio.org/
AUTHOR - Chad MatsallaTop
Email bioinformatics1 at dieselwurks dot com
CONTRIBUTORSTop
Sendu Bala, bix@sendu.me.uk
APPENDIXTop
The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _