Bio::Tools::Run::GenericParameters - An object for the parameters used to run programs

BioPerl documentation Contained in the BioPerl distribution.

Index

Code Index:

NAME

Top

Bio::Tools::Run::GenericParameters - An object for the parameters used to run programs

SYNOPSIS

Top

  my $void   = $obj->set_parameter("parameter_name","parameter_value"); 
  my $value  = $obj->get_parameter("parameter_name");

DESCRIPTION

Top

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.

FEEDBACK

Top

Mailing Lists

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

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 Bugs

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 Matsalla

Top

Email bioinformatics1 at dieselwurks dot com

CONTRIBUTORS

Top

Sendu Bala, bix@sendu.me.uk

APPENDIX

Top

The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _

get_parameter

 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_parameter

 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_parameters

 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
BioPerl documentation Contained in the BioPerl distribution. 
#
# BioPerl module for wrapping runtime parameters
#
# Please direct questions and support issues to <bioperl-l@bioperl.org> 
#
# Cared for by Chad Matsalla (bioinformatics1 at dieselwurks dot com)
#
# Copyright Chad Matsalla
#
# You may distribute this module under the same terms as perl itself

# POD documentation - main docs before the code


# Let the code begin...

package Bio::Tools::Run::GenericParameters;
use strict;

use base qw(Bio::Root::Root Bio::Tools::Run::ParametersI);

sub new {
    my ($class, @args) = @_;
    my $self = $class->SUPER::new(@args);
    return $self;
}


sub get_parameter {
    my ($self,$arg) = @_;
    return $self->{params}->{$arg};
}


sub set_parameter {
    my ($self,$name,$value) = @_;
    $self->{params}->{$name} = $value;
}


sub available_parameters {
    my $self = shift;
    return keys %{$self->{params}};
}

1;