Documentation of 'hep.physics.event.BaseEvent' Java class
BaseEvent
hep.physics.event

Class BaseEvent

  • All Implemented Interfaces:
    HEPEvent
    Direct Known Subclasses:
    GeneratorEvent


    public class BaseEvent
    extends java.lang.Object
    implements HEPEvent
    A simple implementation of HEPEvent
    • Constructor Summary

      Constructors 
      Constructor and Description
      BaseEvent(int run, int event) 
      BaseEvent(int run, int event, long timestamp)
      Create a new event with an explicit timestamp
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      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
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • BaseEvent

        public BaseEvent(int run,
                         int event)
        Parameters:
        run - The run number
        event - Create a new event. The timestamp will be set to the current time.
      • BaseEvent

        public BaseEvent(int run,
                         int event,
                         long timestamp)
        Create a new event with an explicit timestamp
        Parameters:
        run - Teh run number
        event - The event number
        timestamp - The timestamp. By convention this is measured in nS since 1-jan-1970 GMT.
    • Method Detail

      • get

        public java.lang.Object get(java.lang.String key)
        Description copied from interface: HEPEvent
        Get an object from the event
        Specified by:
        get in interface HEPEvent
        Parameters:
        key - The key for the object
      • getEventNumber

        public int getEventNumber()
        Specified by:
        getEventNumber in interface HEPEvent
        Returns:
        The event number
      • getRunNumber

        public int getRunNumber()
        Specified by:
        getRunNumber in interface HEPEvent
        Returns:
        The run number for this event
      • getTags

        public java.util.Map getTags()
        Description copied from interface: HEPEvent
        An arbitrary set of tags that can be associated with the event. Intended to be used for fast event selection.
        Specified by:
        getTags in interface HEPEvent
      • keys

        public java.util.Set keys()
        Specified by:
        keys in interface HEPEvent
        Returns:
        The set of keys stored in the event
      • put

        public void put(java.lang.String key,
                        java.lang.Object component)
        Description copied from interface: HEPEvent
        Puts an arbitrary object into the event
        Specified by:
        put in interface HEPEvent
        Parameters:
        key - The key for this object
        component - The object to add
      • getTimeStamp

        public long getTimeStamp()
        Description copied from interface: HEPEvent
        Get the current timestamp. By convention this is measured in nS since 1-jan-1970 GMT.
        Specified by:
        getTimeStamp in interface HEPEvent
        Returns:
        The timestamp.

DMelt 3.0 © DataMelt by jWork.ORG

You see the box below because you did not login.