bio::describablei(3pm) [debian man page]

Bio::DescribableI(3pm)					User Contributed Perl Documentation				    Bio::DescribableI(3pm)

NAME

       Bio::DescribableI - interface for objects with human readable names and descriptions

SYNOPSIS

	   # to test this is a describable object

	   $obj->isa("Bio::DescribableI") ||
	     $obj->throw("$obj does not implement the Bio::DescribableI interface");

	   # accessors

	   $name = $obj->display_name();
	   $desc = $obj->description();

DESCRIPTION

       This interface describes methods expected on describable objects, ie ones which have human displayable names and descriptions

FEEDBACK

   Mailing Lists
       User feedback is an integral part of the evolution of this and other Bioperl modules. Send your comments and suggestions preferably to one
       of the Bioperl mailing lists.  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 the bugs and their resolution.  Bug reports can be submitted via the
       web:

	 https://redmine.open-bio.org/projects/bioperl/

AUTHOR - Ewan Birney
       Email birney@sanger.ac.uk

Implementation Specific Functions
       These functions are the ones that a specific implementation must define.

   display_name
	Title	: display_name
	Usage	: $string    = $obj->display_name()
	Function: A string which is what should be displayed to the user
		  the string should have no spaces (ideally, though a cautious
		  user of this interface would not assumme this) and should be
		  less than thirty characters (though again, double checking
		  this is a good idea)
	Returns : A scalar
	Status	: Virtual

   description
	Title	: description
	Usage	: $string    = $obj->description()
	Function: A text string suitable for displaying to the user a
		  description. This string is likely to have spaces, but
		  should not have any newlines or formatting - just plain
		  text. The string should not be greater than 255 characters
		  and clients can feel justified at truncating strings at 255
		  characters for the purposes of display
	Returns : A scalar
	Status	: Virtual

perl v5.14.2							    2012-03-02						    Bio::DescribableI(3pm)

Check Out this Related Man Page

Bio::Search::StatisticsI(3pm)				User Contributed Perl Documentation			     Bio::Search::StatisticsI(3pm)

NAME

       Bio::Search::StatisticsI - A Base object for statistics

SYNOPSIS

	 # do not use this object directly, it provides the following methods
	 # for its subclasses

	 my $void   = $obj->set_statistic("statistic_name","statistic_value");
	 my $value  = $obj->get_statistic("statistic_name");

DESCRIPTION

       This is a basic container to hold the statistics returned from a program.

FEEDBACK

   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
       Email bioinformatics1 at dieselwurks dot com

APPENDIX

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

   get_statistic
	Title	: get_statistic
	Usage	: $statistic_object->get_statistic($statistic_name);
	Function: Get the value of a statistic named $statistic_name
	Returns : A scalar that should be a string
	Args	: A scalar that should be a string

   set_statistic
	Title	: set_statistic
	Usage	: $statistic_object->set_statistic($statistic_name => $statistic_value);
	Function: Set the value of a statistic named $statistic_name to $statistic_value
	Returns : Void
	Args	: A hash containing name=>value pairs

perl v5.14.2							    2012-03-02					     Bio::Search::StatisticsI(3pm)

Linux and UNIX Man Pages

bio::describablei(3pm) [debian man page]

Check Out this Related Man Page