org.das2.qds.examples

Class DemoFunction1

java.lang.Object

org.das2.qds.AbstractQFunction

org.das2.qds.examples.DemoFunction1

All Implemented Interfaces:

QFunction

public class DemoFunction1
extends AbstractQFunction

First example function just returns sine of the function.

Constructor Summary

Constructors

Constructor and Description
DemoFunction1()

Method Summary

Modifier and Type	Method and Description
QDataSet	exampleInput() Discover an example input.
QDataSet	value(QDataSet parm) Evaluate the function at the location.

Methods inherited from class org.das2.qds.AbstractQFunction

exampleOutput, values

Methods inherited from class java.lang.Object

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

Constructor Detail

DemoFunction1

public DemoFunction1()

Method Detail

value

public QDataSet value(QDataSet parm)

Description copied from interface: QFunction

Evaluate the function at the location. A rank 1 dataset of N parameters is passed in, and a rank 1 dataset of M parameters is returned. It's presumed that this is calculated in interactive time (1/30sec) for GUI applications like attaching ephemeris ticks to an axis (note no monitor parameter to indicate feedback).

Specified by:

value in interface QFunction

Specified by:

value in class AbstractQFunction

Parameters:

parm - rank 1 bundle of N elements, or rank 2 array of such.

Returns:

rank 1 bundle of M elements, or rank 2 array of such.

exampleInput

public QDataSet exampleInput()

Description copied from interface: QFunction

Discover an example input. Result is a rank 1 bundle QDataSet.

QFunction ff= TestFunction();
ff.exampleInput().length();  // how many parameters the function takes
QDataSet bds= ff.exampleInput().property( QDataSet.BUNDLE_0 );
bds.slice(0).property( QDataSet.UNITS )       // function should handle convertible units (e.g. TimeAxes Ephemeris).
bds.slice(0).property( QDataSet.VALID_MIN )   // absolute limits of domain of the function
bds.slice(0).property( QDataSet.VALID_MAX )
bds.slice(0).property( QDataSet.TYPICAL_MIN ) // domain of the function parameter
bds.slice(0).property( QDataSet.TYPICAL_MAX )
bds.slice(0).property( QDataSet.CADENCE ) // granularity of the function parameter
bds.slice(0).property( QDataSet.LABEL )   // label for the parameter

slice(0) is the first argument, slice(1) would be the second, etc. This would be a bundle. Note, for functions that have only one argument, like F(T)→[R,MLT,MLAT], this may return a rank 0 dataset. Clients should pass a dataset to the value method a dataset with the same geometry.

Specified by:

exampleInput in interface QFunction

Specified by:

exampleInput in class AbstractQFunction

Returns:

rank 1 bundle of N elements, or rank 0 for functions when the function has just one parameter.