org.das2.stream

Class PacketDescriptor

java.lang.Object

org.das2.stream.PacketDescriptor

All Implemented Interfaces:

java.lang.Cloneable

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

Represents the global properties of the stream, that are accessible to datasets within.

Constructor Summary

Constructors

Constructor and Description
PacketDescriptor()
PacketDescriptor(org.w3c.dom.Element element) creates a new PacketDescriptor
PacketDescriptor(int id, org.w3c.dom.Element element) creates a new PacketDescriptor

Method Summary

Modifier and Type	Method and Description
void	addYDescriptor(SkeletonDescriptor y)
java.lang.Object	clone()
static PacketDescriptor	createLegacyPacketDescriptor(java.util.Map dsdf)
org.w3c.dom.Element	getDOMElement(org.w3c.dom.Document document)
int	getId() return the ID associated with this packet type, or -99 if no id has been assigned.
java.util.Map	getProperties()
java.lang.Object	getProperty(java.lang.String name)
int	getSizeBytes()
StreamXDescriptor	getXDescriptor()
int	getYCount()
SkeletonDescriptor	getYDescriptor(int index)
java.util.List	getYDescriptors() Returns a List of SkeletonDescriptor instances that represent the y planes in a packet.
DatumVector[]	read(java.nio.ByteBuffer input)
void	setProperty(java.lang.String name, java.lang.Object value)
void	setXDescriptor(StreamXDescriptor x)
java.lang.String	toString()
void	write(Datum xTag, DatumVector[] vectors, java.nio.ByteBuffer output)

Methods inherited from class java.lang.Object

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

Constructor Detail

PacketDescriptor

public PacketDescriptor(org.w3c.dom.Element element)
                 throws StreamException

creates a new PacketDescriptor

Parameters:

element -

Throws:

StreamException

PacketDescriptor

public PacketDescriptor(int id,
                        org.w3c.dom.Element element)
                 throws StreamException

creates a new PacketDescriptor

Parameters:

id -

element -

Throws:

StreamException

PacketDescriptor

public PacketDescriptor()

Method Detail

getId

public int getId()

return the ID associated with this packet type, or -99 if no id has been assigned.

Returns:

the id or -99

getXDescriptor

public StreamXDescriptor getXDescriptor()

setXDescriptor

public void setXDescriptor(StreamXDescriptor x)

addYDescriptor

public void addYDescriptor(SkeletonDescriptor y)

getYCount

public int getYCount()

getYDescriptors

public java.util.List getYDescriptors()

Returns a List of SkeletonDescriptor instances that represent the y planes in a packet. The List is unmodifiable and will throw an exception if any attempt is made to alter the list. The contents of the list will not be updated if a yDescriptor is added to this packet descriptor.

Returns:

a List of y planes

getYDescriptor

public SkeletonDescriptor getYDescriptor(int index)

getSizeBytes

public int getSizeBytes()

read

public DatumVector[] read(java.nio.ByteBuffer input)

write

public void write(Datum xTag,
                  DatumVector[] vectors,
                  java.nio.ByteBuffer output)

createLegacyPacketDescriptor

public static PacketDescriptor createLegacyPacketDescriptor(java.util.Map dsdf)

getDOMElement

public org.w3c.dom.Element getDOMElement(org.w3c.dom.Document document)

getProperty

public java.lang.Object getProperty(java.lang.String name)

getProperties

public java.util.Map getProperties()

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object