MDSplus

Class StringArray

java.lang.Object

MDSplus.Data

MDSplus.Array

MDSplus.StringArray

public class StringArray
extends Array

Array description for DTYPE_T . Will handle arrays of string like TDI, i.e. padding to the longest string, for C++, in order to retain compatibility with CLASS_A, DTYPE_Tdescriptors.

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
StringArray(String[] inDatum)
StringArray(String[] inDatum, int[] dims)
StringArray(String[] inDatum, int[] dims, Data help, Data units, Data error, Data validation)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
byte[]	getByteArray() Convert this data into a byte array.
static Data	getData(String[] datum, int[] dims, Data help, Data units, Data error, Data validation)
double[]	getDoubleArray() Convert this data into a long array.
Data	getElementAt(int idx)
float[]	getFloatArray() Convert this data into a float array.
int[]	getIntArray() Convert this data into a int array.
long[]	getLongArray() Convert this data into a long array.
protected Array	getPortionAt(int startIdx, int[] newDims, int newSize)
short[]	getShortArray() Convert this data into a short array.
int	getSize()
int	getSizeInBytes()
String[]	getStringArray()
void	setElementAt(int idx, Data data)
protected void	setPortionAt(Array data, int startIdx, int size)

Methods inherited from class MDSplus.Array

getElementAt, getShape, setElementAt, setShape

Methods inherited from class MDSplus.Data

compile, compile, convertToDate, data, deserialize, evaluate, execute, executeWithContext, getByte, getCtxTree, getDimensionAt, getDouble, getError, getFloat, getHelp, getInt, getLong, getMdsMsg, getShort, getString, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StringArray

public StringArray(String[] inDatum)

StringArray

public StringArray(String[] inDatum,
                   int[] dims)
            throws MdsException

Throws:

MdsException

StringArray

public StringArray(String[] inDatum,
                   int[] dims,
                   Data help,
                   Data units,
                   Data error,
                   Data validation)
            throws MdsException

Throws:

MdsException

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getData

public static Data getData(String[] datum,
                           int[] dims,
                           Data help,
                           Data units,
                           Data error,
                           Data validation)

getElementAt

public Data getElementAt(int idx)

Specified by:

getElementAt in class Array

getSize

public int getSize()

Overrides:

getSize in class Array

getPortionAt

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

Specified by:

getPortionAt in class Array

Throws:

MdsException

setElementAt

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

Specified by:

setElementAt in class Array

Throws:

MdsException

setPortionAt

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

Specified by:

setPortionAt in class Array

Throws:

MdsException

getByteArray

public byte[] getByteArray()
                    throws MdsException

Description copied from class: Data

Convert this data into a byte array. Implemented at this class level by returning TDI data(BYTE(this)). If data() fails or the returned class is not array, generates an exception. In Java and C++ will return a 1 dimensional array using row-first ordering if a multidimensional array.

Overrides:

getByteArray in class Data

Throws:

MdsException

getShortArray

public short[] getShortArray()
                      throws MdsException

Description copied from class: Data

Convert this data into a short array. Implemented at this class level by returning TDI data(WORD(this)). If data() fails or the returned class is not array, generates an exception. In Java and C++ will return a 1 dimensional array using row-first ordering if a multidimensional array.

Overrides:

getShortArray in class Data

Throws:

MdsException

getIntArray

public int[] getIntArray()
                  throws MdsException

Description copied from class: Data

Convert this data into a int array. Implemented at this class level by returning TDI data (LONG(this)). If data() fails or the returned class is not array, generates an exception. In Java and C++ will return a 1 dimensional array using row-first ordering if a multidimensional array.

Overrides:

getIntArray in class Data

Throws:

MdsException

getLongArray

public long[] getLongArray()
                    throws MdsException

Description copied from class: Data

Convert this data into a long array. Implemented at this class level by returning TDI data(QUADWORD(this)). If data() fails or the returned class is not array, generates an exception. In Java and C++ will return a 1 dimensional array using row-first ordering if a multidimensional array.

Overrides:

getLongArray in class Data

Throws:

MdsException

getFloatArray

public float[] getFloatArray()
                      throws MdsException

Description copied from class: Data

Convert this data into a float array. Implemented at this class level by returning TDI data(QUADWORD(this)). If data() fails or the returned class is not array, generates an exception. In Java and C++ will return a 1 dimensional array using row-first ordering if a multidimensional array.

Overrides:

getFloatArray in class Data

Throws:

MdsException

getDoubleArray

public double[] getDoubleArray()
                        throws MdsException

Description copied from class: Data

Convert this data into a long array. Implemented at this class level by returning TDI data(QUADWORD(this)). If data() fails or the returned class is not array, generates an exception. In Java and C++ will return a 1 dimensional array using row-first ordering if a multidimensional array.

Overrides:

getDoubleArray in class Data

Throws:

MdsException

getStringArray

public String[] getStringArray()

Overrides:

getStringArray in class Data

getSizeInBytes

public int getSizeInBytes()

Overrides:

getSizeInBytes in class Data