The primary functions for TimeSeriesContainers are:

public void setName(String pathname)
public String getFullName()


public void setUnits(String dataUnits)
public String getUnits()


public void setType(String dataType) {
public String getType()


public void setStartTime(HecTime startTime)
public HecTime getStartTime()


public void setEndTime(HecTime endTime)
public HecTime getEndTime()


public int getNumberValues()

Storing Regular Interval Data

Regular interval time series data only uses a start date/time and position from the start for data values; no time array is stored with the data as the date and time are implied from the position within the block. For a position where data does not exist, a missing data flag is stored (hec.heclib.util.Heclib.UNDEFINED_DOUBLE), which is usually compressed when stored or trimed when read. For regular interval data you do not need to provide a time array for storing data, only the start date/time and data array. The E part of the pathname identifies the time interval

public int setValues(double dataValues[])

A TimeSeriesContainer is written to DSS using a HecTimeSeries object:

public int write (TimeSeriesContainer timeSeriesContainer)

Where zero (0) is returned on a successful write and a negative value for unsuccessful. Do not reuse HecTimeSeries objects or TimeSeriesContainers; create a new one for every write or read.

Storing Irregular Interval Data

A date/time is explicitly stored with every data value for irregular interval time series data, so a time array is specified along with the data array for TimeSeriesContainers. The setStartTime() and setEndTime() are optional functions used for storing irregular interval data. When used with the "replace" flag, they will identify the time window and remove any data on disk within the time window before writing (allowing data values to be deleted), otherwise the time array identifies the start and end. The irregular interval time block is obtained from the E part of the pathname. Note, the selection of this part (and spelling) is important; refer to the discussion for irregular interval time series data.

public int set(double dataValues[], HecTimeArray hecTimes)

A TimeSeriesContainer is written to DSS using a HecTimeSeries object:

public int write (TimeSeriesContainer timeSeriesContainer)

Where zero (0) is returned on a successful write and a negative value for unsuccessful. Do not reuse HecTimeSeries objects or TimeSeriesContainers; create a new one for every write or read.