|
0
|
1 # $Id: EventGeneratorI.pm,v 1.7 2002/10/22 07:45:14 lapp Exp $
|
|
|
2 #
|
|
|
3 # BioPerl module for Bio::Event::EventGeneratorI
|
|
|
4 #
|
|
|
5 # Cared for by Jason Stajich <jason@bioperl.org>
|
|
|
6 #
|
|
|
7 # Copyright Jason Stajich
|
|
|
8 #
|
|
|
9 # You may distribute this module under the same terms as perl itself
|
|
|
10
|
|
|
11 # POD documentation - main docs before the code
|
|
|
12
|
|
|
13 =head1 NAME
|
|
|
14
|
|
|
15 Bio::Event::EventGeneratorI - This interface describes the basic event generator class.
|
|
|
16
|
|
|
17 =head1 SYNOPSIS
|
|
|
18
|
|
|
19 # Do not use this object directly
|
|
|
20 # This object has the basic methods for describing an event generator
|
|
|
21
|
|
|
22 =head1 DESCRIPTION
|
|
|
23
|
|
|
24 This object describes the basic event generator system. It basically allows one to attach one or many event handlers.
|
|
|
25
|
|
|
26
|
|
|
27 =head1 FEEDBACK
|
|
|
28
|
|
|
29 =head2 Mailing Lists
|
|
|
30
|
|
|
31 User feedback is an integral part of the evolution of this and other
|
|
|
32 Bioperl modules. Send your comments and suggestions preferably to
|
|
|
33 the Bioperl mailing list. Your participation is much appreciated.
|
|
|
34
|
|
|
35 bioperl-l@bioperl.org - General discussion
|
|
|
36 http://bioperl.org/MailList.shtml - About the mailing lists
|
|
|
37
|
|
|
38 =head2 Reporting Bugs
|
|
|
39
|
|
|
40 Report bugs to the Bioperl bug tracking system to help us keep track
|
|
|
41 of the bugs and their resolution. Bug reports can be submitted via
|
|
|
42 email or the web:
|
|
|
43
|
|
|
44 bioperl-bugs@bioperl.org
|
|
|
45 http://bugzilla.bioperl.org/
|
|
|
46
|
|
|
47 =head1 AUTHOR - Jason Stajich
|
|
|
48
|
|
|
49 Email jason@bioperl.org
|
|
|
50
|
|
|
51 Describe contact details here
|
|
|
52
|
|
|
53 =head1 CONTRIBUTORS
|
|
|
54
|
|
|
55 Additional contributors names and emails here
|
|
|
56
|
|
|
57 =head1 APPENDIX
|
|
|
58
|
|
|
59 The rest of the documentation details each of the object methods.
|
|
|
60 Internal methods are usually preceded with a _
|
|
|
61
|
|
|
62 =cut
|
|
|
63
|
|
|
64
|
|
|
65 # Let the code begin...
|
|
|
66
|
|
|
67
|
|
|
68 package Bio::Event::EventGeneratorI;
|
|
|
69 use vars qw(@ISA);
|
|
|
70 use strict;
|
|
|
71
|
|
|
72 @ISA = qw( Bio::Root::RootI );
|
|
|
73
|
|
|
74 =head2 attach_EventHandler
|
|
|
75
|
|
|
76 Title : attach_EventHandler
|
|
|
77 Usage : $parser->attatch_EventHandler($handler)
|
|
|
78 Function: Adds an event handler to listen for events
|
|
|
79 Returns : none
|
|
|
80 Args : Bio::Event::EventHandlerI
|
|
|
81
|
|
|
82 =cut
|
|
|
83
|
|
|
84 sub attach_EventHandler{
|
|
|
85 my ($self) = @_;
|
|
|
86 $self->throw_not_implemented();
|
|
|
87 }
|
|
|
88
|
|
|
89 1;
|
