All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class hep.analysis.EventGenerator 

java.lang.Object
   |
   +----hep.analysis.EventHandler
           |
           +----hep.analysis.EventGenerator
public abstract class EventGenerator
extends EventHandler
implements EventSource
A subclass of EventGenerator can be loaded as an event generator in the application. It is advisable to use the program page wizard to create a subclass of EventGenerator.

Constructor Index

o EventGenerator()

Method Index

o close()
Override to do cleanup when generator is no longer used
o generateEvent()
Return an instance of EventData that offers access to all of the relevant fields for one event.
o getEventDataClass()
override to specify class of objects returned by generate event
o getName()
override to specify name of event generator
o getNextEvent()
Returns generateEvent().
o getTotalNumberOfEvents()
Override if the number of events is known, and return that number.

Constructors

o EventGenerator 
 public EventGenerator()

Methods

o generateEvent 
 public abstract EventData generateEvent() throws EndOfDataException
Return an instance of EventData that offers access to all of the relevant fields for one event.

Throws: EndOfDataException
when there are no more events available
o getTotalNumberOfEvents 
 public int getTotalNumberOfEvents()
Override if the number of events is known, and return that number.

o getNextEvent 
 public final EventData getNextEvent() throws EndOfDataException
Returns generateEvent(). This is a method from the EventSource interface.

Throws: EndOfDataException
when there are no more events available
See Also:
EventSource
o close 
 public void close()
Override to do cleanup when generator is no longer used

o getName 
 public String getName()
override to specify name of event generator

o getEventDataClass 
 public Class getEventDataClass()
override to specify class of objects returned by generate event 

All Packages  Class Hierarchy  This Package  Previous  Next  Index