hydroScalingAPI.modules.rainfallRunoffModel.objects
Class HillSlopeTimeSeries

java.lang.Object
  hydroScalingAPI.modules.rainfallRunoffModel.objects.HillSlopeTimeSeries

public class HillSlopeTimeSeries
extends java.lang.Object

This class manages a time series of parameters associated to the hillslope. For example rainfall, or any other temporaly varaible parameter.

Author:

Ricardo Mantilla

Constructor Summary

HillSlopeTimeSeries(int regIn, int numElem)
Creates new HillSlopeTimeSeries

Method Summary

void	addDateAndValue(java.util.Calendar newRecordTime, java.lang.Float newRecordValue) Adds a new date and value to the time series
float	getMaxRecord() The maximum value observed in the time series
float	getMeanRecord() The average value observed in the time series
float	getRecord(java.util.Calendar atThisTime) Returns a value for the record for a given time
float	getSize() The record lenght

Methods inherited from class java.lang.Object

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

Constructor Detail

HillSlopeTimeSeries

public HillSlopeTimeSeries(int regIn,
                           int numElem)

Creates new HillSlopeTimeSeries

Parameters:

regIn - Register interval in milliseconds

Method Detail

addDateAndValue

public void addDateAndValue(java.util.Calendar newRecordTime,
                            java.lang.Float newRecordValue)

Adds a new date and value to the time series

Parameters:

newRecordTime - The time at which the record was taken

newRecordValue - The value of the record taken

getRecord

public float getRecord(java.util.Calendar atThisTime)

Returns a value for the record for a given time

Parameters:

atThisTime - The desired time to evaluate

Returns:

A float with the record value

getSize

public float getSize()

The record lenght

Returns:

The record lenght

getMaxRecord

public float getMaxRecord()

The maximum value observed in the time series

Returns:

The maximum recorded value

getMeanRecord

public float getMeanRecord()

The average value observed in the time series

Returns:

The mean recorded value