org.das2.qds

Interface RankZeroDataSet

All Superinterfaces:

QDataSet

All Known Implementing Classes:

DRank0DataSet, Slice0DataSet, TrDDataSet, TrFDataSet, TrLDataSet

public interface RankZeroDataSet
extends QDataSet

interface provide access to a rank 0 dataset, which can be thought of as a scalar (and set of correlated scalars) with metadata. This is a marker interface, since it no longer adds any new methods to the interface. TODO: this really needs to be studied, see org.virbo.qstream.SimpleStreamFormatter.timeDigits(SimpleStreamFormatter.java:188) which would assume the data was a rank0 dataset, which it once was because it came from slice0.

Field Summary

Fields inherited from interface org.das2.qds.QDataSet

BIN_MAX, BIN_MIN, BIN_MINUS, BIN_PLUS, BINS_0, BINS_1, BUNDLE_0, BUNDLE_1, BUNDLE_2, BUNDLE_3, CACHE_TAG, CADENCE, CONTEXT_0, COORDINATE_FRAME, DEFAULT_FILL_VALUE, DELTA_MINUS, DELTA_PLUS, DEPEND_0, DEPEND_1, DEPEND_2, DEPEND_3, DEPENDNAME_0, DEPENDNAME_1, DESCRIPTION, ELEMENT_DIMENSIONS, ELEMENT_LABEL, ELEMENT_NAME, FILL_VALUE, FORMAT, JOIN_0, LABEL, MAX_HIGH_RANK, MAX_PLANE_COUNT, MAX_RANK, MAX_UNIT_BUNDLE_COUNT, METADATA, METADATA_MODEL, MIN_WAVEFORM_LENGTH, MONOTONIC, NAME, NOTES, PLANE_0, QUBE, RENDER_TYPE, SCALE_TYPE, SOURCE, START_INDEX, TITLE, TYPICAL_MAX, TYPICAL_MIN, UNITS, USER_PROPERTIES, VALID_MAX, VALID_MIN, VALUE_BINS_MIN_MAX, VALUE_COORDINATE_FRAME_COMPLEX_NUMBER, VALUE_METADATA_MODEL_ISTP, VALUE_METADATA_MODEL_SPASE, VALUE_RENDER_TYPE_COMPOSITE_IMAGE, VALUE_RENDER_TYPE_DIGITAL, VALUE_RENDER_TYPE_EVENTS_BAR, VALUE_RENDER_TYPE_NNSPECTROGRAM, VALUE_RENDER_TYPE_SERIES, VALUE_SCALE_TYPE_LINEAR, VALUE_SCALE_TYPE_LOG, VERSION, WEIGHTS

Method Summary

Modifier and Type	Method and Description
java.lang.Object	property(java.lang.String name) accessor for properties attached to the dataset.
double	value() rank 0 accessor.

Methods inherited from interface org.das2.qds.QDataSet

capability, length, length, length, length, property, rank, slice, trim, value, value, value, value

Method Detail

value

double value()

rank 0 accessor.

Specified by:

value in interface QDataSet

Returns:

the scalar value stored in this dataset.

Throws:

java.lang.IllegalArgumentException - if the dataset is not rank 0.

property

java.lang.Object property(java.lang.String name)

Description copied from interface: QDataSet

accessor for properties attached to the dataset. See final static members for example properties.

Specified by:

property in interface QDataSet

Parameters:

name - property name, such as "DEPEND_0" or "UNITS"

Returns:

the value

See Also:

QDataSet.DEPEND_0, QDataSet.UNITS