org.das2.stream.PacketDescriptor

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

PacketDescriptor( org.w3c.dom.Element element )

creates a new PacketDescriptor

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

creates a new PacketDescriptor

PacketDescriptor( )

addYDescriptor

addYDescriptor( org.das2.stream.SkeletonDescriptor y ) → void

Parameters

y - a SkeletonDescriptor

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]

clone

clone( ) → Object

Returns:

java.lang.Object

[search for examples] [view on GitHub] [view on old javadoc] [view source]

createLegacyPacketDescriptor

createLegacyPacketDescriptor( java.util.Map dsdf ) → org.das2.stream.PacketDescriptor

Parameters

dsdf - a java.util.Map

Returns:

org.das2.stream.PacketDescriptor

[search for examples] [view on GitHub] [view on old javadoc] [view source]

getDOMElement

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

Parameters

document - a Document

Returns:

org.w3c.dom.Element

[search for examples] [view on GitHub] [view on old javadoc] [view source]

getId

getId( ) → int

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

Returns:

the id or -99

[search for examples] [view on GitHub] [view on old javadoc] [view source]

getProperties

getProperties( ) → java.util.Map

Returns:

java.util.Map

[search for examples] [view on GitHub] [view on old javadoc] [view source]

getProperty

getProperty( String name ) → Object

Parameters

name - a String

Returns:

java.lang.Object

[search for examples] [view on GitHub] [view on old javadoc] [view source]

getSizeBytes

getSizeBytes( ) → int

Returns:

int

[search for examples] [view on GitHub] [view on old javadoc] [view source]

getXDescriptor

getXDescriptor( ) → org.das2.stream.StreamXDescriptor

Returns:

org.das2.stream.StreamXDescriptor

[search for examples] [view on GitHub] [view on old javadoc] [view source]

getYCount

getYCount( ) → int

Returns:

int

[search for examples] [view on GitHub] [view on old javadoc] [view source]

getYDescriptor

getYDescriptor( int index ) → org.das2.stream.SkeletonDescriptor

Parameters

index - an int

Returns:

org.das2.stream.SkeletonDescriptor

[search for examples] [view on GitHub] [view on old javadoc] [view source]

getYDescriptors

getYDescriptors( ) → java.util.List

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

[search for examples] [view on GitHub] [view on old javadoc] [view source]

read

read( java.nio.ByteBuffer input ) → org.das2.datum.DatumVector[]

Parameters

input - a ByteBuffer

Returns:

org.das2.datum.DatumVector[]

[search for examples] [view on GitHub] [view on old javadoc] [view source]

setProperty

setProperty( String name, Object value ) → void

Parameters

name - a String
value - an Object

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]

setXDescriptor

setXDescriptor( org.das2.stream.StreamXDescriptor x ) → void

Parameters

x - a StreamXDescriptor

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]

toString

toString( ) → String

Returns:

java.lang.String

[search for examples] [view on GitHub] [view on old javadoc] [view source]

write

write( Datum xTag, org.das2.datum.DatumVector[] vectors, java.nio.ByteBuffer output ) → void

Parameters

xTag - a Datum
vectors - an org.das2.datum.DatumVector[]
output - a ByteBuffer

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]