org.das2.dataset.test

Class SineWaveDataSetDescriptor

java.lang.Object

org.das2.dataset.DataSetDescriptor

org.das2.dataset.test.SineWaveDataSetDescriptor

All Implemented Interfaces:

Displayable

public class SineWaveDataSetDescriptor
extends DataSetDescriptor

Field Summary

Fields inherited from class org.das2.dataset.DataSetDescriptor

properties

Constructor Summary

Constructors

Constructor and Description
SineWaveDataSetDescriptor(Datum amplitude, Datum period) Creates a new instance of SineWaveDataSetDescriptor with arbitrary phase.
SineWaveDataSetDescriptor(Datum amplitude, Datum period, Datum phase) Creates a new instance of SineWaveDataSetDescriptor

Method Summary

Modifier and Type	Method and Description
DataSet	getDataSetImpl(Datum start, Datum end, Datum resolution, ProgressMonitor monitor) getDataSetImpl implements the getDataSet for this DataSetDescriptor implementation.
Units	getXUnits()
static SineWaveDataSetDescriptor	newDataSetDescriptor(java.util.Map map)

Methods inherited from class org.das2.dataset.DataSetDescriptor

addDataSetUpdateListener, create, drawListIcon, fireDataSetUpdateEvent, getDataSet, getDataSetCache, getDataSetID, getListIcon, getListLabel, getProperty, removeDataSetUpdateListener, requestDataSet, requestDataSet, reset, setDefaultCaching, setProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

SineWaveDataSetDescriptor

public SineWaveDataSetDescriptor(Datum amplitude,
                                 Datum period)

Creates a new instance of SineWaveDataSetDescriptor with arbitrary phase.

Parameters:

amplitude - the amplitude of the signal.

period - is in the offset units of phase.

SineWaveDataSetDescriptor

public SineWaveDataSetDescriptor(Datum amplitude,
                                 Datum period,
                                 Datum phase)

Creates a new instance of SineWaveDataSetDescriptor

Parameters:

amplitude - the amplitude of the signal.

period - is in the offset units of phase.

phase - datum in the same units as period. null indicates that the phase is arbitrary and will change based on the data request.

Method Detail

getDataSetImpl

public DataSet getDataSetImpl(Datum start,
                              Datum end,
                              Datum resolution,
                              ProgressMonitor monitor)
                       throws DasException

Description copied from class: DataSetDescriptor

getDataSetImpl implements the getDataSet for this DataSetDescriptor implementation. The getDataSet call of the abstract DataSetDescriptor uses this routine to satisfy requests and fill its cache. This caching may be disabled via setDefaultCaching. To satisfy the request, a DataSet should be returned with an x tag range that contains start and end, with a resolution finer than that requested.

Specified by:

getDataSetImpl in class DataSetDescriptor

Parameters:

start - beginning of range for the request.

end - end of the range for the request.

resolution - the resolution requirement for the reqeust. null may be used to request the finest resolution available or intrinic resolution.

Throws:

DasException

getXUnits

public Units getXUnits()

Specified by:

getXUnits in class DataSetDescriptor

Returns:

the x units of the DataSetDescriptor that parameterize the data. This is used to identify dataSet requests.

newDataSetDescriptor

public static SineWaveDataSetDescriptor newDataSetDescriptor(java.util.Map map)
                                                      throws DasException

Throws:

DasException