MDSplus

Class String

java.lang.Object

MDSplus.Data

MDSplus.Scalar

MDSplus.String

public class String
extends Scalar

Class description of DTYPE_T. NOTE String name may clash with languase-defined String in Java. In this case it will necessary to specify the package name. Constructor: String(string)

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
String(String datum)
String(String datum, Data help, Data units, Data error, Data validation)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object data)
byte	getByte() Convert this data into a byte.
byte[]	getByteArray() Convert this data into a byte array.
static Data	getData(String datum, Data help, Data units, Data error, Data validation)
double	getDouble() Convert this data into a double.
double[]	getDoubleArray() Convert this data into a long array.
float	getFloat() Convert this data into a float.
float[]	getFloatArray() Convert this data into a float array.
int	getInt() Convert this data into a int.
int[]	getIntArray() Convert this data into a int array.
long	getLong() Convert this data into a long.
long[]	getLongArray() Convert this data into a long array.
short	getShort() Convert this data into a short.
short[]	getShortArray() Convert this data into a short array.
int	getSizeInBytes()
String	getString() Convert this data into a STRING.

Methods inherited from class MDSplus.Scalar

getSize

Methods inherited from class MDSplus.Data

compile, compile, convertToDate, data, deserialize, evaluate, execute, executeWithContext, getDimensionAt, getError, getHelp, getMdsMsg, getShape, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

String

public String(String datum)

String

public String(String datum,
              Data help,
              Data units,
              Data error,
              Data validation)

Method Detail

equals

public boolean equals(Object data)

Overrides:

equals in class Object

getData

public static Data getData(String datum,
                           Data help,
                           Data units,
                           Data error,
                           Data validation)

getByte

public byte getByte()
             throws MdsException

Description copied from class: Data

Convert this data into a byte. Implemented at this class level by returning TDI data(BYTE(this)). If data() fails or the returned class is not scalar, generated an exception.

Overrides:

getByte in class Data

Throws:

MdsException

getShort

public short getShort()
               throws MdsException

Convert this data into a short. Implemented at this class level by returning TDI data(WORD(this)).If data() fails or the returned class is not scalar, generated an exception.

Overrides:

getShort in class Data

Throws:

MdsException

getInt

public int getInt()
           throws MdsException

Convert this data into a int. Implemented at this class level by returning TDI data(LONG(this)).If data() fails or the returned class is not scalar, generated an exception.

Overrides:

getInt in class Data

Throws:

MdsException

getLong

public long getLong()
             throws MdsException

Convert this data into a long. Implemented at this class level by returning TDI data(QUADWORD(this)).If data() fails or the returned class is not scalar, generated an exception.

Overrides:

getLong in class Data

Throws:

MdsException

getFloat

public float getFloat()
               throws MdsException

Convert this data into a float. Implemented at this class level by returning TDI data(F_FLOAT(this)).If data() fails or the returned class is not scalar, generated an exception.

Overrides:

getFloat in class Data

Throws:

MdsException

getDouble

public double getDouble()
                 throws MdsException

Convert this data into a double. Implemented at this class level by returning TDI data(FT_FLOAT(this)). If data() fails or the returned class is not scalar, generated an exception.

Overrides:

getDouble in class Data

Throws:

MdsException

getByteArray

public byte[] getByteArray()
                    throws MdsException

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

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

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

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

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

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

getString

public String getString()

Description copied from class: Data

Convert this data into a STRING. Implemented at this class level by returning TDI data((this)). If data() fails or the returned class is not string, generates an exception.

Overrides:

getString in class Data

getSizeInBytes

public int getSizeInBytes()

Overrides:

getSizeInBytes in class Data