WaveInterface (MDSplus jScope 7.134.9 API)

java.lang.Object
- mds.wave.WaveInterface

public class WaveInterface
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`add_signal`
`boolean`	`asynch_update`
`static boolean`	`auto_color_on_expr`
`static boolean`	`brief_error`
`ColorMap`	`colorMap`
`int[]`	`colors_idx`
`DataProvider`	`dp`
`String`	`error`
`protected boolean[]`	`evaluated`
`String`	`experiment`
`int`	`height`
`boolean`	`horizontal_flip`
`String`	`in_def_node`
`int`	`in_grid_mode`
`String[]`	`in_label`
`String[]`	`in_low_err`
`String`	`in_shot`
`String`	`in_timemax`
`String`	`in_timemin`
`String`	`in_title`
`String[]`	`in_up_err`
`boolean`	`in_upd_limits`
`String[]`	`in_x`
`String`	`in_xlabel`
`String`	`in_xmax`
`String`	`in_xmin`
`String[]`	`in_y`
`String`	`in_ylabel`
`String`	`in_ymax`
`String`	`in_ymin`
`boolean[]`	`interpolates`
`boolean`	`is_image`
`protected boolean`	`is_signal_added`
`boolean`	`isContinuousUpdate`
`boolean`	`keep_ratio`
`double`	`legend_x`
`double`	`legend_y`
`int[]`	`markers`
`int[]`	`markers_step`
`int[]`	`mode1D`
`int[]`	`mode2D`
`int`	`num_shot`
`int`	`num_waves`
`String`	`provider`
`boolean`	`reversed`
`long[]`	`shots`
`boolean`	`show_legend`
`static SignalBox`	`sig_box`
`int`	`signal_select`
`Signal[]`	`signals`
`double`	`timemax`
`double`	`timemin`
`String`	`title`
`boolean`	`vertical_flip`
`String[]`	`w_error`
`Waveform`	`wave`
`boolean`	`x_log`
`String`	`xlabel`
`double`	`xmax`
`double`	`xmin`
`boolean`	`y_log`
`String`	`ylabel`
`double`	`ymax`
`double`	`ymin`
`String`	`zlabel`

Constructor Summary

Constructors
Constructor and Description
`WaveInterface()`
`WaveInterface(DataProvider dp)`
`WaveInterface(Waveform wave)`
`WaveInterface(Waveform wave, DataProvider dp)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`AddFrames(String frames)`
`void`	`AddFrames(String frames, String frames_time)`
`protected static String`	`AddNewLineCode(String s)`
`boolean`	`AddSignal(String y_expr)`
`boolean`	`AddSignal(String x_expr, String y_expr)`
`boolean`	`AddSignals(String[] x_expr, String[] y_expr)`
`boolean`	`allEvaluated()`
`void`	`Erase()`
`boolean`	`EvaluateOthers()`
`void`	`EvaluateShot(long shot)`
`ColorMap`	`getColorMap()`
`DataProvider`	`getDataProvider()`
`String`	`getErrorTitle()`
`String`	`getErrorTitle(boolean brief)`
`Frames`	`getFrames()`
`boolean`	`getModified()`
`int`	`GetNumEvaluatedSignal()`
`long[]`	`GetShotArray(String in_shots)`
`static long[]`	`GetShotArray(String in_shots, String exp, DataProvider dp)`
`String[]`	`GetSignalsName()`
`boolean[]`	`GetSignalsState()`
`boolean`	`GetSignalState(int i)`
`boolean`	`isAddSignal()`
`boolean`	`IsSignalAdded()`
`protected static String`	`RemoveNewLineCode(String s)`
`void`	`setAddSignal(boolean add_signal)`
`void`	`SetAsImage(boolean is_image)`
`void`	`setColorMap(ColorMap colorMap)`
`void`	`SetDataProvider(DataProvider _dp)`
`void`	`setExperiment(String experiment)`
`void`	`setFrames(Frames f)`
`void`	`SetIsSignalAdded(boolean is_signal_added)`
`void`	`SetLegendPosition(double x, double y)`
`void`	`setLimits()`
`void`	`setLimits(Signal s)`
`void`	`setModified(boolean state)`
`void`	`setShotArray(String in_shot)`
`void`	`setSignalState(String name, boolean state)`
`void`	`ShowLegend(boolean state)`
`int`	`StartEvaluate()`
`boolean`	`UpdateShot(long[] curr_shots)`
`static void`	`WriteLine(PrintWriter out, String prompt, String value)`

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

Field Detail

sig_box
```
public static SignalBox sig_box
```

auto_color_on_expr

public static boolean auto_color_on_expr

brief_error
```
public static boolean brief_error
```

wave
```
public Waveform wave
```

num_waves
```
public int num_waves
```

x_log
```
public boolean x_log
```

y_log
```
public boolean y_log
```

in_label
```
public String[] in_label
```

in_x
```
public String[] in_x
```

in_y
```
public String[] in_y
```

in_up_err
```
public String[] in_up_err
```

in_low_err
```
public String[] in_low_err
```

in_xmin
```
public String in_xmin
```

in_xmax
```
public String in_xmax
```

in_ymax
```
public String in_ymax
```

in_ymin
```
public String in_ymin
```

in_timemax
```
public String in_timemax
```

in_timemin
```
public String in_timemin
```

in_title
```
public String in_title
```

in_xlabel
```
public String in_xlabel
```

in_ylabel
```
public String in_ylabel
```

in_def_node
```
public String in_def_node
```

in_upd_limits
```
public boolean in_upd_limits
```

experiment
```
public String experiment
```

in_grid_mode
```
public int in_grid_mode
```

height
```
public int height
```

isContinuousUpdate
```
public boolean isContinuousUpdate
```

in_shot
```
public String in_shot
```

num_shot
```
public int num_shot
```

reversed
```
public boolean reversed
```

show_legend
```
public boolean show_legend
```

legend_x
```
public double legend_x
```

legend_y
```
public double legend_y
```

markers_step
```
public int[] markers_step
```

markers
```
public int[] markers
```

colors_idx
```
public int[] colors_idx
```

interpolates
```
public boolean[] interpolates
```

mode2D
```
public int[] mode2D
```

mode1D
```
public int[] mode1D
```

shots
```
public long[] shots
```

error
```
public String error
```

provider
```
public String provider
```

w_error
```
public String[] w_error
```

signals
```
public Signal[] signals
```

xmax
```
public double xmax
```

xmin
```
public double xmin
```

ymax
```
public double ymax
```

ymin
```
public double ymin
```

timemax
```
public double timemax
```

timemin
```
public double timemin
```

title
```
public String title
```

xlabel
```
public String xlabel
```

ylabel
```
public String ylabel
```

zlabel
```
public String zlabel
```

dp
```
public DataProvider dp
```

asynch_update
```
public boolean asynch_update
```

evaluated
```
protected boolean[] evaluated
```

is_image
```
public boolean is_image
```

keep_ratio
```
public boolean keep_ratio
```

horizontal_flip
```
public boolean horizontal_flip
```

vertical_flip
```
public boolean vertical_flip
```

signal_select
```
public int signal_select
```

add_signal
```
protected boolean add_signal
```

is_signal_added
```
protected boolean is_signal_added
```

colorMap
```
public ColorMap colorMap
```

Constructor Detail

WaveInterface
```
public WaveInterface()
```

WaveInterface
```
public WaveInterface(DataProvider dp)
```

WaveInterface
```
public WaveInterface(Waveform wave)
```

WaveInterface

public WaveInterface(Waveform wave,
                     DataProvider dp)

Method Detail

AddNewLineCode

protected static String AddNewLineCode(String s)

GetShotArray

public static long[] GetShotArray(String in_shots,
                                  String exp,
                                  DataProvider dp)
                           throws IOException

Throws:: IOException

RemoveNewLineCode

protected static String RemoveNewLineCode(String s)

WriteLine

public static void WriteLine(PrintWriter out,
                             String prompt,
                             String value)

AddFrames
```
public void AddFrames(String frames)
```

AddFrames

public void AddFrames(String frames,
                      String frames_time)

AddSignal

public boolean AddSignal(String y_expr)

AddSignal

public boolean AddSignal(String x_expr,
                         String y_expr)

AddSignals

public boolean AddSignals(String[] x_expr,
                          String[] y_expr)

allEvaluated
```
public boolean allEvaluated()
```

Erase
```
public void Erase()
```

EvaluateOthers
```
public boolean EvaluateOthers()
```

EvaluateShot

public void EvaluateShot(long shot)
                  throws Exception

Throws:: Exception

getColorMap
```
public ColorMap getColorMap()
```

getDataProvider
```
public DataProvider getDataProvider()
```

getErrorTitle
```
public String getErrorTitle()
```

getErrorTitle

public String getErrorTitle(boolean brief)

getFrames
```
public Frames getFrames()
```

getModified
```
public boolean getModified()
```

GetNumEvaluatedSignal
```
public int GetNumEvaluatedSignal()
```

GetShotArray

public long[] GetShotArray(String in_shots)
                    throws IOException

Throws:: IOException

GetSignalsName
```
public String[] GetSignalsName()
```

GetSignalsState
```
public boolean[] GetSignalsState()
```

GetSignalState
```
public boolean GetSignalState(int i)
```

isAddSignal
```
public boolean isAddSignal()
```

IsSignalAdded
```
public boolean IsSignalAdded()
```

setAddSignal

public void setAddSignal(boolean add_signal)

SetAsImage

public void SetAsImage(boolean is_image)

setColorMap

public void setColorMap(ColorMap colorMap)

SetDataProvider

public void SetDataProvider(DataProvider _dp)

setExperiment

public void setExperiment(String experiment)

setFrames
```
public void setFrames(Frames f)
```

SetIsSignalAdded

public void SetIsSignalAdded(boolean is_signal_added)

SetLegendPosition

public void SetLegendPosition(double x,
                              double y)

setLimits
```
public void setLimits()
```

setLimits

public void setLimits(Signal s)
               throws Exception

Throws:: Exception

setModified

public void setModified(boolean state)

setShotArray

public void setShotArray(String in_shot)
                  throws IOException

Throws:: IOException

setSignalState

public void setSignalState(String name,
                           boolean state)

ShowLegend

public void ShowLegend(boolean state)

StartEvaluate

public int StartEvaluate()
                  throws IOException

Throws:: IOException

UpdateShot

public boolean UpdateShot(long[] curr_shots)
                   throws IOException

Throws:: IOException

Class WaveInterface

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sig_box

auto_color_on_expr

brief_error

wave

num_waves

x_log

y_log

in_label

in_x

in_y

in_up_err

in_low_err

in_xmin

in_xmax

in_ymax

in_ymin

in_timemax

in_timemin

in_title

in_xlabel

in_ylabel

in_def_node

in_upd_limits

experiment

in_grid_mode

height

isContinuousUpdate

in_shot

num_shot

reversed

show_legend

legend_x

legend_y

markers_step

markers

colors_idx

interpolates

mode2D

mode1D

shots

error

provider

w_error

signals

xmax

xmin

ymax

ymin

timemax

timemin

title

xlabel

ylabel

zlabel

dp

asynch_update

evaluated

is_image

keep_ratio

horizontal_flip

vertical_flip

signal_select

add_signal

is_signal_added

colorMap

Constructor Detail

WaveInterface

WaveInterface

WaveInterface

WaveInterface

Method Detail

AddNewLineCode

GetShotArray

RemoveNewLineCode