Data (MDSplus mdsobjects 7.134.11 API)

java.lang.Object
- MDSplus.Data

Direct Known Subclasses:

Apd, Array, Compound, Empty, Ident, Scalar, TreeNode
```
public class Data
extends Object
```
Class Data represents the ancestor of every MDSplus data. It defines and implements the generic methods for retrieving data as native types. These methods can be implemented at this generic level since thay are internally based of TDIfunctionality. Private methods of data will convert the data object instance into a MDSplus descriptor and viceversa: this mechanism allows the usage of TDI. An important fact about Data classes is that no data management code is provided: the classes only priovide a mere interface to the underlying TDI functionality. As data evaluation is routinely performed, a private field of Data will hold the cached copy of the latest data() result. This cached copy will be returned directly (instead of passing through TdiData()) only if all the components forming this data hierarchy did not change Private method mayHaveChanged() defaults to false for most scalar classes except, for example, Nid or Ident. For composite classes, mayHaveChanged() will return false in most cases only if mayHaveChanges() reutrns false for all the linked data instances are immutable. For some CompoundData classes such as FunctionData whose opcode refers to user provided routines, mayHaveChanged() returns always true.

Version:

1.0

Author:

manduchi

Field Summary

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

Constructor Summary

Constructors
Constructor and Description

Data()

Data(Data help, Data units, Data error, Data validation)

Constructors
Constructor and Description
`Data()`
`Data(Data help, Data units, Data error, Data validation)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Data`	`compile(String expr)` Static method (routine in C++) which compiles the expression (via TdiCompile()) and returns the object instance correspondind to the compiled expression.
`static Data`	`compile(String expr, Data... args)`
`protected static String`	`convertToDate(long time)`
`Data`	`data()` Method data exports TDI data() functionality, i.e.
`static Data`	`deserialize(byte[] serialized)`
`String`	`evaluate()` Return the result of TDI evaluate(this).
`static Data`	`execute(String expr, Data... data)`
`Data`	`executeWithContext(String expr, Data... args)`
`byte`	`getByte()` Convert this data into a byte.
`byte[]`	`getByteArray()` Convert this data into a byte array.
`Data`	`getDimensionAt(int idx)`
`double`	`getDouble()` Convert this data into a double.
`double[]`	`getDoubleArray()` Convert this data into a long array.
`Data`	`getError()` Get the error field.
`float`	`getFloat()` Convert this data into a float.
`float[]`	`getFloatArray()` Convert this data into a float array.
`Data`	`getHelp()` Returns help).
`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.
`static String`	`getMdsMsg(int status)`
`int[]`	`getShape()` Get the array dimensions as an integer array.
`short`	`getShort()` Convert this data into a short.
`short[]`	`getShortArray()` Convert this data into a short array.
`int`	`getSize()`
`int`	`getSizeInBytes()`
`String`	`getString()` Convert this data into a STRING.
`String[]`	`getStringArray()`
`static long`	`getTime()`
`Data`	`getUnits()` Return units field.
`Data`	`getValidation()` Get the error field.
`void`	`plot()`
`byte[]`	`serialize()`
`void`	`setCtxTree(Tree ctxTree)`
`void`	`setError(Data error)` Set the Error field for this Data instance.
`void`	`setHelp(Data help)` Set the Help field for this Data instance.
`void`	`setUnits(Data units)`
`void`	`setValidation(Data validation)`
`static Data`	`toData(byte d)`
`static Data`	`toData(byte[] d)`
`static Data`	`toData(double d)`
`static Data`	`toData(double[] d)`
`static Data`	`toData(float d)`
`static Data`	`toData(float[] d)`
`static Data`	`toData(int d)`
`static Data`	`toData(int[] d)`
`static Data`	`toData(long d)`
`static Data`	`toData(long[] d)`
`static Data`	`toData(short d)`
`static Data`	`toData(short[] d)`
`static Data`	`toData(String d)`
`static Data`	`toData(String[] d)`
`double[]`	`toDouble()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DTYPE_BU
```
public static final int DTYPE_BU
```
    See Also:
    
    Constant Field Values
  - DTYPE_WU
```
public static final int DTYPE_WU
```
    See Also:
    
    Constant Field Values
  - DTYPE_LU
```
public static final int DTYPE_LU
```
    See Also:
    
    Constant Field Values
  - DTYPE_QU
```
public static final int DTYPE_QU
```
    See Also:
    
    Constant Field Values
  - DTYPE_OU
```
public static final int DTYPE_OU
```
    See Also:
    
    Constant Field Values
  - DTYPE_B
```
public static final int DTYPE_B
```
    See Also:
    
    Constant Field Values
  - DTYPE_W
```
public static final int DTYPE_W
```
    See Also:
    
    Constant Field Values
  - DTYPE_L
```
public static final int DTYPE_L
```
    See Also:
    
    Constant Field Values
  - DTYPE_Q
```
public static final int DTYPE_Q
```
    See Also:
    
    Constant Field Values
  - DTYPE_O
```
public static final int DTYPE_O
```
    See Also:
    
    Constant Field Values
  - DTYPE_FLOAT
```
public static final int DTYPE_FLOAT
```
    See Also:
    
    Constant Field Values
  - DTYPE_DOUBLE
```
public static final int DTYPE_DOUBLE
```
    See Also:
    
    Constant Field Values
  - DTYPE_T
```
public static final int DTYPE_T
```
    See Also:
    
    Constant Field Values
  - DTYPE_IDENT
```
public static final int DTYPE_IDENT
```
    See Also:
    
    Constant Field Values
  - DTYPE_NID
```
public static final int DTYPE_NID
```
    See Also:
    
    Constant Field Values
  - DTYPE_PATH
```
public static final int DTYPE_PATH
```
    See Also:
    
    Constant Field Values
  - DTYPE_PARAM
```
public static final int DTYPE_PARAM
```
    See Also:
    
    Constant Field Values
  - DTYPE_SIGNAL
```
public static final int DTYPE_SIGNAL
```
    See Also:
    
    Constant Field Values
  - DTYPE_DIMENSION
```
public static final int DTYPE_DIMENSION
```
    See Also:
    
    Constant Field Values
  - DTYPE_WINDOW
```
public static final int DTYPE_WINDOW
```
    See Also:
    
    Constant Field Values
  - DTYPE_SLOPE
```
public static final int DTYPE_SLOPE
```
    See Also:
    
    Constant Field Values
  - DTYPE_FUNCTION
```
public static final int DTYPE_FUNCTION
```
    See Also:
    
    Constant Field Values
  - DTYPE_CONGLOM
```
public static final int DTYPE_CONGLOM
```
    See Also:
    
    Constant Field Values
  - DTYPE_RANGE
```
public static final int DTYPE_RANGE
```
    See Also:
    
    Constant Field Values
  - DTYPE_ACTION
```
public static final int DTYPE_ACTION
```
    See Also:
    
    Constant Field Values
  - DTYPE_DISPATCH
```
public static final int DTYPE_DISPATCH
```
    See Also:
    
    Constant Field Values
  - DTYPE_PROGRAM
```
public static final int DTYPE_PROGRAM
```
    See Also:
    
    Constant Field Values
  - DTYPE_ROUTINE
```
public static final int DTYPE_ROUTINE
```
    See Also:
    
    Constant Field Values
  - DTYPE_PROCEDURE
```
public static final int DTYPE_PROCEDURE
```
    See Also:
    
    Constant Field Values
  - DTYPE_METHOD
```
public static final int DTYPE_METHOD
```
    See Also:
    
    Constant Field Values
  - DTYPE_DEPENDENCY
```
public static final int DTYPE_DEPENDENCY
```
    See Also:
    
    Constant Field Values
  - DTYPE_CONDITION
```
public static final int DTYPE_CONDITION
```
    See Also:
    
    Constant Field Values
  - DTYPE_EVENT
```
public static final int DTYPE_EVENT
```
    See Also:
    
    Constant Field Values
  - DTYPE_WITH_UNITS
```
public static final int DTYPE_WITH_UNITS
```
    See Also:
    
    Constant Field Values
  - DTYPE_CALL
```
public static final int DTYPE_CALL
```
    See Also:
    
    Constant Field Values
  - DTYPE_WITH_ERROR
```
public static final int DTYPE_WITH_ERROR
```
    See Also:
    
    Constant Field Values
  - DTYPE_LIST
```
public static final int DTYPE_LIST
```
    See Also:
    
    Constant Field Values
  - DTYPE_TUPLE
```
public static final int DTYPE_TUPLE
```
    See Also:
    
    Constant Field Values
  - DTYPE_DICTIONARY
```
public static final int DTYPE_DICTIONARY
```
    See Also:
    
    Constant Field Values
  - DTYPE_DSC
```
public static final int DTYPE_DSC
```
    See Also:
    
    Constant Field Values
  - TreeNEGATE_CONDITION
```
public static final int TreeNEGATE_CONDITION
```
    See Also:
    
    Constant Field Values
  - TreeIGNORE_UNDEFINED
```
public static final int TreeIGNORE_UNDEFINED
```
    See Also:
    
    Constant Field Values
  - TreeIGNORE_STATUS
```
public static final int TreeIGNORE_STATUS
```
    See Also:
    
    Constant Field Values
  - TreeDEPENDENCY_AND
```
public static final int TreeDEPENDENCY_AND
```
    See Also:
    
    Constant Field Values
  - TreeDEPENDENCY_OR
```
public static final int TreeDEPENDENCY_OR
```
    See Also:
    
    Constant Field Values
  - CLASS_S
```
public static final int CLASS_S
```
    See Also:
    
    Constant Field Values
  - CLASS_D
```
public static final int CLASS_D
```
    See Also:
    
    Constant Field Values
  - CLASS_A
```
public static final int CLASS_A
```
    See Also:
    
    Constant Field Values
  - CLASS_R
```
public static final int CLASS_R
```
    See Also:
    
    Constant Field Values
  - CLASS_APD
```
public static final int CLASS_APD
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Data
```
public Data()
```
  - Data
```
public Data(Data help,
            Data units,
            Data error,
            Data validation)
```
- Method Detail
  - toDouble
```
public double[] toDouble()
                  throws Exception
```
    Throws:
    
    Exception
  - setCtxTree
```
public void setCtxTree(Tree ctxTree)
```
  - compile
```
public static Data compile(String expr)
```
    Static method (routine in C++) which compiles the expression (via TdiCompile()) and returns the object instance correspondind to the compiled expression.
    
    Parameters:
    
    expr -
    
    args -
  - executeWithContext
```
public Data executeWithContext(String expr,
                               Data... args)
```
  - convertToDate
```
protected static String convertToDate(long time)
```
  - getTime
```
public static long getTime()
```
  - compile
```
public static Data compile(String expr,
                           Data... args)
```
  - execute
```
public static Data execute(String expr,
                           Data... data)
```
  - deserialize
```
public static Data deserialize(byte[] serialized)
```
  - serialize
```
public byte[] serialize()
```
  - getMdsMsg
```
public static String getMdsMsg(int status)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - data
```
public Data data()
```
    Method data exports TDI data() functionality, i.e. returns a native type (scalar or array). If isImmutable() returns true and a cached instance is avavilable, this is returned instead.
  - evaluate
```
public String evaluate()
```
    Return the result of TDI evaluate(this).
  - getByte
```
public byte getByte()
             throws MdsException
```
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    Throws:
    
    MdsException
  - getShape
```
public int[] getShape()
               throws MdsException
```
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    Throws:
    
    MdsException
  - getString
```
public String getString()
                 throws MdsException
```
    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.
    
    Throws:
    
    MdsException
  - getStringArray
```
public String[] getStringArray()
                        throws MdsException
```
    Throws:
    
    MdsException
  - getSize
```
public int getSize()
```
  - getSizeInBytes
```
public int getSizeInBytes()
```
  - getUnits
```
public Data getUnits()
```
    Return units field. EmptyData is returned if no units defined.
  - getHelp
```
public Data getHelp()
```
    Returns help). Returns EmptyData if no help field defined.
  - getError
```
public Data getError()
```
    Get the error field. Returns EmptyData if no error defined.
  - getValidation
```
public Data getValidation()
```
    Get the error field. Returns EmptyData if no error defined.
  - setUnits
```
public void setUnits(Data units)
```
    Parameters:
    
    units - Set the Units field for this Data instance.
  - setHelp
```
public void setHelp(Data help)
```
    Set the Help field for this Data instance.
    
    Parameters:
    
    help -
  - setError
```
public void setError(Data error)
```
    Set the Error field for this Data instance.
    
    Parameters:
    
    error -
  - setValidation
```
public void setValidation(Data validation)
```
  - getDimensionAt
```
public Data getDimensionAt(int idx)
```
  - plot
```
public void plot()
```
  - toData
```
public static Data toData(byte d)
```
  - toData
```
public static Data toData(short d)
```
  - toData
```
public static Data toData(int d)
```
  - toData
```
public static Data toData(long d)
```
  - toData
```
public static Data toData(float d)
```
  - toData
```
public static Data toData(double d)
```
  - toData
```
public static Data toData(String d)
```
  - toData
```
public static Data toData(byte[] d)
```
  - toData
```
public static Data toData(short[] d)
```
  - toData
```
public static Data toData(int[] d)
```
  - toData
```
public static Data toData(long[] d)
```
  - toData
```
public static Data toData(float[] d)
```
  - toData
```
public static Data toData(double[] d)
```
  - toData
```
public static Data toData(String[] d)
```

Class Data

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DTYPE_BU

DTYPE_WU

DTYPE_LU

DTYPE_QU

DTYPE_OU

DTYPE_B

DTYPE_W

DTYPE_L

DTYPE_Q

DTYPE_O

DTYPE_FLOAT

DTYPE_DOUBLE

DTYPE_T

DTYPE_IDENT

DTYPE_NID

DTYPE_PATH

DTYPE_PARAM

DTYPE_SIGNAL

DTYPE_DIMENSION

DTYPE_WINDOW

DTYPE_SLOPE

DTYPE_FUNCTION

DTYPE_CONGLOM

DTYPE_RANGE

DTYPE_ACTION

DTYPE_DISPATCH

DTYPE_PROGRAM

DTYPE_ROUTINE

DTYPE_PROCEDURE

DTYPE_METHOD

DTYPE_DEPENDENCY

DTYPE_CONDITION

DTYPE_EVENT

DTYPE_WITH_UNITS

DTYPE_CALL

DTYPE_WITH_ERROR

DTYPE_LIST

DTYPE_TUPLE

DTYPE_DICTIONARY

DTYPE_DSC

TreeNEGATE_CONDITION

TreeIGNORE_UNDEFINED

TreeIGNORE_STATUS

TreeDEPENDENCY_AND

TreeDEPENDENCY_OR

CLASS_S

CLASS_D

CLASS_A

CLASS_R

CLASS_APD

Constructor Detail

Data

Data

Method Detail

toDouble

setCtxTree

compile

executeWithContext

convertToDate

getTime

compile

execute

deserialize

serialize

getMdsMsg

toString

data

evaluate

getByte

getShort

getInt

getLong

getFloat

getDouble