View Javadoc

1   package org.lcsim.event;
2   
3   /** Simple interface to store generic user data.
4    * To store your own classes they have to implement
5    * this interface.
6    * @version $Id: GenericObject.java,v 1.3 2006/06/28 04:48:31 jstrube Exp $
7    */
8   
9   public interface GenericObject
10  {
11      /** Number of integer values stored in this object.
12       */
13      public int getNInt();
14      
15      /** Number of float values stored in this object.
16       */
17      public int getNFloat();
18      
19      /** Number of double values stored in this object.
20       */
21      public int getNDouble();
22      
23      /** Returns the integer value for the given index.
24       */
25      public int getIntVal(int index);
26      
27      /** Returns the float value for the given index.
28       */
29      public float getFloatVal(int index);
30      
31      /** Returns the double value for the given index.
32       */
33      public double getDoubleVal(int index);
34      
35      /** True if objects of the implementation class have a fixed size, i.e
36       * getNInt, getNFloat and getNDouble will return values that are constant during
37       * the lifetime of the object.
38       */
39      public boolean isFixedSize();
40  
41  } // class or interface
42