org.das2.qstream

Class PlaneDescriptor

java.lang.Object

org.das2.qstream.PlaneDescriptor

All Implemented Interfaces:

java.lang.Cloneable

public class PlaneDescriptor
extends java.lang.Object
implements java.lang.Cloneable

Describes one of the bundled elements, for example one QDataSet, within a packet.

Constructor Summary

Constructors

Constructor and Description
PlaneDescriptor()

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	clone()
DataSetBuilder	getBuilder()
java.lang.String[]	getBundles() get a copy of a list of all the names of the bundled datasets.
QDataSet	getDs() return the dataset encoded in this plane.
int	getElements()
java.lang.String	getName()
int[]	getQube()
int	getRank()
TransferType	getType()
Units	getUnits()
void	setBuilder(DataSetBuilder builder)
void	setDs(QDataSet ds)
void	setName(java.lang.String name)
void	setQube(int[] qube)
void	setRank(int rank)
void	setType(TransferType type)
void	setUnits(Units units)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PlaneDescriptor

public PlaneDescriptor()

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getRank

public int getRank()

setRank

public void setRank(int rank)

getQube

public int[] getQube()

setQube

public void setQube(int[] qube)

getElements

public int getElements()

getDs

public QDataSet getDs()

return the dataset encoded in this plane. Note this is just a convenient place to store a dataset, and someone else must calculate it and store it with setDs.

Returns:

setDs

public void setDs(QDataSet ds)

getUnits

public Units getUnits()

setUnits

public void setUnits(Units units)

getBuilder

public DataSetBuilder getBuilder()

setBuilder

public void setBuilder(DataSetBuilder builder)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getType

public TransferType getType()

setType

public void setType(TransferType type)

getBundles

public java.lang.String[] getBundles()

get a copy of a list of all the names of the bundled datasets.

Returns:

clone

protected java.lang.Object clone()
                          throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException