View Javadoc

1   /*
2    * @(#) GamingPersistentData.java Oct 25, 2004
3    * 
4    * Copyright (c) 2003-2005 Delft University of Technology, Jaffalaan 5, 2628 BX
5    * Delft, the Netherlands. All rights reserved.
6    * 
7    * See for project information <a href="http://www.simulation.tudelft.nl/">
8    * www.simulation.tudelft.nl </a>.
9    * 
10   * The source code and binary code of this software is proprietary information
11   * of Delft University of Technology.
12   */
13  package org.gscg.common.interactionlayer.dataobjects;
14  
15  import java.io.Serializable;
16  
17  /***
18   * The GamingPersistentData is used to contain data meant for a persisten which
19   * is present client-side.
20   * <p>
21   * Copyright (c) 2003-2005 Delft University of Technology, Jaffalaan 5, 2628 BX
22   * Delft, the Netherlands. All rights reserved.
23   * 
24   * See for project information <a href="http://www.simulation.tudelft.nl/">
25   * www.simulation.tudelft.nl </a>.
26   * 
27   * The source code and binary code of this software is proprietary information
28   * of Delft University of Technology.
29   * 
30   * @author <a
31   *         href="http://www.tbm.tudelft.nl/webstaf/stijnh/index.htm">Stijn-Pieter
32   *         van Houten </a>
33   * @version $Revision: 1.1 $ $Date: 2005/06/16 12:33:58 $
34   * @since 1.0.0
35   */
36  public class GamingPersistentData implements Serializable
37  {
38  	/*** the serial version uid */
39  	private static final long serialVersionUID = 11L;
40  
41  	/*** the min value */
42  	private double min = Double.NaN;
43  
44  	/*** the max value */
45  	private double max = Double.NaN;
46  
47  	/*** the number of measurements */
48  	private long n = 0L;
49  
50  	/*** the sampleMean */
51  	private double sampleMean = Double.NaN;
52  
53  	/*** the sum */
54  	private double sum = Double.NaN;
55  
56  	/*** the variance sum */
57  	private double varianceSum = Double.NaN;
58  
59  	/*** the name of the persistent */
60  	private String persistentName = null;
61  
62  
63  	/***
64  	 * constructs a new GamingPersistentData
65  	 * 
66  	 * @param min the min value
67  	 * @param max the max value
68  	 * @param n the n value
69  	 * @param sampleMean the sample mean
70  	 * @param sum the sum
71  	 * @param varianceSum the variance sum
72  	 * @param persistentName the name of the persistent
73  	 */
74  	public GamingPersistentData(final double min, final double max,
75  			final long n, final double sampleMean, final double sum,
76  			final double varianceSum, final String persistentName)
77  	{
78  		this.min = min;
79  		this.max = max;
80  		this.n = n;
81  		this.sampleMean = sampleMean;
82  		this.sum = sum;
83  		this.varianceSum = varianceSum;
84  		this.persistentName = persistentName;
85  	}
86  
87  	/***
88  	 * @return Returns the max.
89  	 */
90  	public double getMax()
91  	{
92  		return this.max;
93  	}
94  
95  	/***
96  	 * @return Returns the min.
97  	 */
98  	public double getMin()
99  	{
100 		return this.min;
101 	}
102 
103 	/***
104 	 * @return Returns n.
105 	 */
106 	public long getN()
107 	{
108 		return this.n;
109 	}
110 
111 	/***
112 	 * @return Returns the sample mean.
113 	 */
114 	public double getSampleMean()
115 	{
116 		return this.sampleMean;
117 	}
118 
119 	/***
120 	 * @return Returns the sum.
121 	 */
122 	public double getSum()
123 	{
124 		return this.sum;
125 	}
126 
127 	/***
128 	 * @return Returns the variance sum.
129 	 */
130 	public double getVarianceSum()
131 	{
132 		return this.varianceSum;
133 	}
134 
135 	/***
136 	 * @return Returns the persistent name.
137 	 */
138 	public String getPersistentName()
139 	{
140 		return this.persistentName;
141 	}
142 }