dap4.core.data

Interface DataAtomic

All Superinterfaces:

Data, DataVariable

public interface DataAtomic
extends DataVariable

DataAtomic represents a non-container object.

Method Summary

Methods

Modifier and Type	Method and Description
long	getCount()
long	getElementSize()
DapType	getType()
Object	read(long index) Provide a read of a single value at a given offset in a (possibly dimensioned) atomic valued variable.
void	read(long start, long count, Object data, long offset) Read of multiple values at once.

Methods inherited from interface dap4.core.data.DataVariable

getVariable

Methods inherited from interface dap4.core.data.Data

getSort, getTemplate

Method Detail

getType

DapType getType()

getCount

long getCount()

getElementSize

long getElementSize()

read

void read(long start,
        long count,
        Object data,
        long offset)
          throws DataException

Read of multiple values at once. The returned value (parametere "data") is some form of java array (e.g. int[]). The type depends on the value of getType(). Note that implementations of this interface are free to provide alternate read methods that return values in e.g. a java.nio.Buffer. Note that unsigned types (e.g. UInt64) are returned as a signed version (e.g. Int64), and will have the proper bit pattern for the unsigned value. If the size of the "data" array is not the correct size, then an error will be returned. For opaque data, the result is ByteBuffer[].

Parameters:

start - the first value to read

count - the number of values to read; |data| must >= (offset+count)

data - the array into which the values are returned

offset - the offset into data into which to read

Throws:

DataException

read

Object read(long index)
            throws DataException

Provide a read of a single value at a given offset in a (possibly dimensioned) atomic valued variable. As mentioned above, unsigned types are returned as a signed version. The type of the returned value is the obvious one (e.g. int->Integer, opaque->ByteBuffer, etc.).

Throws:

DataException