org.das2.qstream

Class QdsToDas23

java.lang.Object

org.das2.qstream.QdsToD2sStream

org.das2.qstream.QdsToDas23

public class QdsToDas23
extends QdsToD2sStream

Write QDataSets that vary over at most 3 independent variables as a Das2 stream. This is the general structure of arrays streamed in a das2.3 stream x [yset yset ...] [y y ...] [zset zset ...] [z z ...] [wset wset ...] [w w ...] Though it's unlikely that all possible components will ever be needed to describe a single dataset. All binary output is streamed in machine-native order. Since datasets written on one architecture are most likely to be read on the same architecture this choice causes the least amount of byte swapping. This is a direct serialization of QDataSet and does not require any legacy das2 classes

Nested Class Summary

Nested classes/interfaces inherited from class org.das2.qstream.QdsToD2sStream

QdsToD2sStream.PacketXferInfo, QdsToD2sStream.QdsXferInfo, QdsToD2sStream.Sequence1D

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AXIS
static double	DEF_SEQ_JITTER
static java.lang.String	OFFSET_1
static java.lang.String	OFFSET_2
static java.lang.String	OFFSET_3
static java.lang.String	REFERENCE

Fields inherited from class org.das2.qstream.QdsToD2sStream

bBinary, DEFAUT_FRAC_SEC, DEFAUT_SIG_DIGIT, FIXED_PKT_TAGS, FORMAT_2_2, FORMAT_2_3_BASIC, FORMAT_2_4_GENERAL, formats, nSecDigit, nSigDigit, VAR_PKT_TAGS

Constructor Summary

Constructors

Constructor and Description
QdsToDas23()
QdsToDas23(int genSigDigits, int fracSecDigits)

Method Summary

Modifier and Type	Method and Description
boolean	canWrite(QDataSet qds) Determine if a given dataset be serialized as a das2.3/basic stream
boolean	write(QDataSet qds, java.io.OutputStream os) Write a QDataSet as a das2.3 stream To test whether it looks like this code could stream a dataset use the canWrite() function.

Methods inherited from class org.das2.qstream.QdsToD2sStream

_stripDotProps, copySimpleProps, getQdsAxis, getSequenceRank1, makeNameFromUnits, newXmlDoc, writeData

Methods inherited from class java.lang.Object

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

Field Detail

OFFSET_1

public static final java.lang.String OFFSET_1

See Also:

Constant Field Values

OFFSET_2

public static final java.lang.String OFFSET_2

See Also:

Constant Field Values

OFFSET_3

public static final java.lang.String OFFSET_3

See Also:

Constant Field Values

REFERENCE

public static final java.lang.String REFERENCE

See Also:

Constant Field Values

AXIS

public static final java.lang.String AXIS

See Also:

Constant Field Values

DEF_SEQ_JITTER

public static final double DEF_SEQ_JITTER

See Also:

Constant Field Values

Constructor Detail

QdsToDas23

public QdsToDas23()

QdsToDas23

public QdsToDas23(int genSigDigits,
                  int fracSecDigits)

Method Detail

canWrite

public boolean canWrite(QDataSet qds)

Determine if a given dataset be serialized as a das2.3/basic stream

Specified by:

canWrite in class QdsToD2sStream

Parameters:

qds - The dataset to write

Returns:

true if this dataset can be serialized as a das2.3/basic stream, false otherwise

write

public boolean write(QDataSet qds,
                     java.io.OutputStream os)
              throws java.io.IOException

Write a QDataSet as a das2.3 stream To test whether it looks like this code could stream a dataset use the canWrite() function. This function may be called multiple times to add additional data to the stream. If a compatible header has already been emitted for a particular dataset it is not re-sent.

Specified by:

write in class QdsToD2sStream

Parameters:

qds - The dataset to write, may have join's bundles etc. but no rank 3 or higher component datasets.

os - an open output stream, which is not closed by this code.

Returns:

true if the entire dataset could be written, false otherwise. IO failures do not return false, they throw. False simply means that this code does not know how (or can't) stream the given dataset. Since deeper inspection occurs when actually writing the data then when testing, false may be returned even if canWrite() returned true.

Throws:

java.io.IOException