| 1 | # | ||
| 2 | # BioPerl module for Bio::Event::EventGeneratorI | ||
| 3 | # | ||
| 4 | # Please direct questions and support issues to <bioperl-l@bioperl.org> | ||
| 5 | # | ||
| 6 | # Cared for by Jason Stajich <jason@bioperl.org> | ||
| 7 | # | ||
| 8 | # Copyright Jason Stajich | ||
| 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::Event::EventGeneratorI - This interface describes the basic event | ||
| 17 | generator class. | ||
| 18 | |||
| 19 | =head1 SYNOPSIS | ||
| 20 | |||
| 21 | # Do not use this object directly | ||
| 22 | # This object has the basic methods for describing an event generator | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This object describes the basic event generator system. It basically | ||
| 27 | allows one to attach one or many event handlers. | ||
| 28 | |||
| 29 | =head1 FEEDBACK | ||
| 30 | |||
| 31 | =head2 Mailing Lists | ||
| 32 | |||
| 33 | User feedback is an integral part of the evolution of this and other | ||
| 34 | Bioperl modules. Send your comments and suggestions preferably to | ||
| 35 | the Bioperl mailing list. Your participation is much appreciated. | ||
| 36 | |||
| 37 | bioperl-l@bioperl.org - General discussion | ||
| 38 | http://bioperl.org/wiki/Mailing_lists - About the mailing lists | ||
| 39 | |||
| 40 | =head2 Support | ||
| 41 | |||
| 42 | Please direct usage questions or support issues to the mailing list: | ||
| 43 | |||
| 44 | I<bioperl-l@bioperl.org> | ||
| 45 | |||
| 46 | rather than to the module maintainer directly. Many experienced and | ||
| 47 | reponsive experts will be able look at the problem and quickly | ||
| 48 | address it. Please include a thorough description of the problem | ||
| 49 | with code and data examples if at all possible. | ||
| 50 | |||
| 51 | =head2 Reporting Bugs | ||
| 52 | |||
| 53 | Report bugs to the Bioperl bug tracking system to help us keep track | ||
| 54 | of the bugs and their resolution. Bug reports can be submitted via the | ||
| 55 | web: | ||
| 56 | |||
| 57 | https://github.com/bioperl/bioperl-live/issues | ||
| 58 | |||
| 59 | =head1 AUTHOR - Jason Stajich | ||
| 60 | |||
| 61 | Email jason@bioperl.org | ||
| 62 | |||
| 63 | =head1 APPENDIX | ||
| 64 | |||
| 65 | The rest of the documentation details each of the object methods. | ||
| 66 | Internal methods are usually preceded with a _ | ||
| 67 | |||
| 68 | =cut | ||
| 69 | |||
| 70 | |||
| 71 | # Let the code begin... | ||
| 72 | |||
| 73 | |||
| 74 | package Bio::Event::EventGeneratorI; | ||
| 75 | 76 | $Bio::Event::EventGeneratorI::VERSION = '1.7.8'; | |
| 76 | 76 | ▶ | use strict; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 77 | |||
| 78 | 76 | ▶ | use base qw(Bio::Root::RootI); |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 79 | |||
| 80 | =head2 attach_EventHandler | ||
| 81 | |||
| 82 | Title : attach_EventHandler | ||
| 83 | Usage : $parser->attatch_EventHandler($handler) | ||
| 84 | Function: Adds an event handler to listen for events | ||
| 85 | Returns : none | ||
| 86 | Args : Bio::Event::EventHandlerI | ||
| 87 | |||
| 88 | =cut | ||
| 89 | |||
| 90 | 0 | ▶ | sub attach_EventHandler{ |
|
Subroutine
attach_EventHandler: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 91 | 0 | my ($self) = @_; | |
| 92 | 0 | $self->throw_not_implemented(); | |
| 93 | } | ||
| 94 | |||
| 95 | 76 | 1; | |