MDSplus

Class Array

java.lang.Object

MDSplus.Data

MDSplus.Array

Direct Known Subclasses:

Float32Array, Float64Array, Int16Array, Int32Array, Int64Array, Int8Array, StringArray, Uint16Array, Uint32Array, Uint64Array, Uint8Array

public abstract class Array
extends Data

Common superclass for arrays (CLASS_A). It contains dimension informationThe contained data is assumed to be row-first ordered. Array - derived classes will hold actual data in language-specific structures. This allows for a direct implementation of operations such as getElementAt() and setElementAt() which would be difficult or impossible to implement via TDI. For the remaining Data methods, the generic mechanism of the superclass' implementation (conversion to MDSplus descriptor, TDI operation conversion back to class instances) is retained.

Version:

1.0

Author:

manduchi

Field Summary

Fields inherited from class MDSplus.Data

CLASS_A, CLASS_APD, CLASS_D, CLASS_R, CLASS_S, DTYPE_ACTION, DTYPE_B, DTYPE_BU, DTYPE_CALL, DTYPE_CONDITION, DTYPE_CONGLOM, DTYPE_DEPENDENCY, DTYPE_DICTIONARY, DTYPE_DIMENSION, DTYPE_DISPATCH, DTYPE_DOUBLE, DTYPE_DSC, DTYPE_EVENT, DTYPE_FLOAT, DTYPE_FUNCTION, DTYPE_IDENT, DTYPE_L, DTYPE_LIST, DTYPE_LU, DTYPE_METHOD, DTYPE_NID, DTYPE_O, DTYPE_OU, DTYPE_PARAM, DTYPE_PATH, DTYPE_PROCEDURE, DTYPE_PROGRAM, DTYPE_Q, DTYPE_QU, DTYPE_RANGE, DTYPE_ROUTINE, DTYPE_SIGNAL, DTYPE_SLOPE, DTYPE_T, DTYPE_TUPLE, DTYPE_W, DTYPE_WINDOW, DTYPE_WITH_ERROR, DTYPE_WITH_UNITS, DTYPE_WU, TreeDEPENDENCY_AND, TreeDEPENDENCY_OR, TreeIGNORE_STATUS, TreeIGNORE_UNDEFINED, TreeNEGATE_CONDITION

Constructor Summary

Constructors

Constructor and Description
Array()
Array(int[] dims, Data help, Data units, Data error, Data validation)

Method Summary

Modifier and Type	Method and Description
abstract Data	getElementAt(int idx)
Data	getElementAt(int[] getDims) Return a single element, if the passed number of dimension is equals to the dimension of dims field.
protected abstract Array	getPortionAt(int startIdx, int[] newDims, int newSize)
int[]	getShape() Get the array dimensions as an integer array.
int	getSize()
void	setElementAt(int[] setDims, Data data)
abstract void	setElementAt(int idx, Data data)
protected abstract void	setPortionAt(Array data, int startIdx, int size)
void	setShape(int[] newDims)

Methods inherited from class MDSplus.Data

compile, compile, convertToDate, data, deserialize, evaluate, execute, executeWithContext, getByte, getByteArray, getDimensionAt, getDouble, getDoubleArray, getError, getFloat, getFloatArray, getHelp, getInt, getIntArray, getLong, getLongArray, getMdsMsg, getShort, getShortArray, getSizeInBytes, getString, getStringArray, getTime, getUnits, getValidation, plot, serialize, setCtxTree, setError, setHelp, setUnits, setValidation, toData, toData, toData, toData, toData, toData, toData, toData, toData, toData, toData, toData, toData, toData, toDouble, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Array

public Array()

Array

public Array(int[] dims,
             Data help,
             Data units,
             Data error,
             Data validation)

Method Detail

getShape

public int[] getShape()

Description copied from class: Data

Get the array dimensions as an integer array. It is implemented at this class level by computing TDI expression SHAPE(this). If shape fails an exception is generated.

Overrides:

getShape in class Data

setShape

public void setShape(int[] newDims)
              throws MdsException

Throws:

MdsException

getSize

public int getSize()

Overrides:

getSize in class Data

getElementAt

public abstract Data getElementAt(int idx)

getPortionAt

protected abstract Array getPortionAt(int startIdx,
                                      int[] newDims,
                                      int newSize)
                               throws MdsException

Throws:

MdsException

setElementAt

public abstract void setElementAt(int idx,
                                  Data data)
                           throws MdsException

Throws:

MdsException

setPortionAt

protected abstract void setPortionAt(Array data,
                                     int startIdx,
                                     int size)
                              throws MdsException

Throws:

MdsException

getElementAt

public Data getElementAt(int[] getDims)
                  throws MdsException

Return a single element, if the passed number of dimension is equals to the dimension of dims field. Otherwise it returns the reshaped array corresponding to the passed dimension array. For example, if the array is bi-dimensional, a single dimension i will specify the i-th row. Note that this method may be implemented at this level since ArrayData has all the required information about data and dimension.

Parameters:

dims -

Throws:

MdsException

setElementAt

public void setElementAt(int[] setDims,
                         Data data)
                  throws MdsException

Throws:

MdsException