org.opentrafficsim.water.statistics

Class XFrequency

java.lang.Object

org.opentrafficsim.water.statistics.XFrequency

All Implemented Interfaces:

Serializable

public class XFrequency
extends Object
implements Serializable

Copyright (c) 2011-2013 TU Delft, Faculty of TBM, Systems and Simulation
This software is licensed without restrictions to Nederlandse Organisatie voor Toegepast Natuurwetenschappelijk Onderzoek TNO (TNO), Erasmus University Rotterdam, Delft University of Technology, Panteia B.V., Stichting Projecten Binnenvaart, Ab Ovo Nederland B.V., Modality Software Solutions B.V., and Rijkswaterstaat - Dienst Water, Verkeer en Leefomgeving, including the right to sub-license sources and derived products to third parties.

Version:

Mar 24, 2013

Author:

Alexander Verbraeck

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description description refers to the title of this counter
protected SortedMap<String,Long>	frequency count represents the values of the counters
protected long	n n represents the number of measurements

Constructor Summary

Constructors

Constructor and Description
XFrequency(String description)

Method Summary

Modifier and Type	Method and Description
void	count(String key) count 1
void	count(String key, long value) count frequency
String	getDescription() returns the description of the counter
SortedMap<String,Long>	getFrequencies() Returns all counters
long	getFrequency(String key) Returns the current counter value for a key
long	getN() Returns the current number of observations
void	initialize() initializes the counter
boolean	isInitialized() is the counter initialized?
String	toString()
int	writeToExcel(Sheet sheet, int startRow) Write statistics to an excel spreadsheet, starting on row "startRow"

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

frequency

protected SortedMap<String,Long> frequency

count represents the values of the counters

n

protected long n

n represents the number of measurements

description

protected String description

description refers to the title of this counter

Constructor Detail

XFrequency

public XFrequency(String description)

Parameters:

description - the description of the statistic

Method Detail

getFrequency

public long getFrequency(String key)

Returns the current counter value for a key

Parameters:

key - the string key for the counter

Returns:

long the counter value

getFrequencies

public SortedMap<String,Long> getFrequencies()

Returns all counters

Returns:

the counter values

getN

public long getN()

Returns the current number of observations

Returns:

long the number of observations

count

public void count(String key,
                  long value)

count frequency

Parameters:

key - the key to count the value under

value - the value

count

public void count(String key)

count 1

Parameters:

key - key

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

initialize

public void initialize()

initializes the counter

isInitialized

public boolean isInitialized()

is the counter initialized?

Returns:

returns whether the counter is initialized

getDescription

public String getDescription()

returns the description of the counter

Returns:

String the description

writeToExcel

public int writeToExcel(Sheet sheet,
                        int startRow)

Write statistics to an excel spreadsheet, starting on row "startRow"

Parameters:

sheet - the excel sheet to write to

startRow - the first row of writing

Returns:

first free row after writing