hep.physics.event
Interface HEPEvent

All Known Subinterfaces:

MCEvent

All Known Implementing Classes:

BaseEvent, GeneratorEvent

public interface HEPEvent

A simple event structure. Designed to be used as a base class for experiment specific event descriptions.

Author:

Tony Johnson

Method Summary

java.lang.Object	get(java.lang.String key) Get an object from the event
int	getEventNumber()
int	getRunNumber()
java.util.Map	getTags() An arbitrary set of tags that can be associated with the event.
long	getTimeStamp() Get the current timestamp.
java.util.Set	keys()
void	put(java.lang.String key, java.lang.Object component) Puts an arbitrary object into the event

Method Detail

getEventNumber

int getEventNumber()

Returns:

The event number

getRunNumber

int getRunNumber()

Returns:

The run number for this event

getTimeStamp

long getTimeStamp()

Get the current timestamp. By convention this is measured in nS since 1-jan-1970 GMT.

Returns:

The timestamp.

put

void put(java.lang.String key,
         java.lang.Object component)

Puts an arbitrary object into the event

Parameters:

key - The key for this object

component - The object to add

get

java.lang.Object get(java.lang.String key)
                     throws java.lang.IllegalArgumentException

Get an object from the event

Parameters:

key - The key for the object

Throws:

java.lang.IllegalArgumentException - if the specified object does not exist in the event.

getTags

java.util.Map getTags()

An arbitrary set of tags that can be associated with the event. Intended to be used for fast event selection.

keys

java.util.Set keys()

Returns:

The set of keys stored in the event