TwoDimensionalDataSource (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.vib.servers.DataSource
- - com.ergotech.vib.servers.SimpleDataSource
  - - com.ergotech.vib.servers.TwoDimensionalDataSource

```
public class TwoDimensionalDataSource
extends SimpleDataSource
```
This generates TwoDimensionalValueObjects for testing VIB components. At least two columns are required to generate a valid value object. If set to use timestamps, the first column always contains a timestamp, generated similarly to how the timestamp is created for the ArrayDataSource.
Each TwoDimensionalValueObject will have n rows (set by the setRows method) and m columns (minimum of 2). The first column (x data) can be int or doubles type data and always contains a timestamp. The first column data (the x values) may be sorted by value or timestamp.

Nested Class Summary
- Nested classes/interfaces inherited from class com.ergotech.vib.servers.SimpleDataSource
  SimpleDataSource.NameEditorData
- Nested classes/interfaces inherited from class com.ergotech.vib.servers.DataSource
  DataSource.Writable

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`booleanYColumns` if set to a non-zero value, this number of boolean columns will be generated.
`int`	`columns` Number of columns.
`boolean`	`constantXSpacing` If set to false the numeric spacing between the x-column values will not be even.
`int`	`doubleYColumns` if set to a non-zero value, this number of double value columns will be generated.
`boolean`	`randomX` This is the whether or not to use random (true) or sequential x values.
`int`	`rows` The number of rows
`boolean`	`sortedX` This defaults to true so that the X Column data is sorted from low to high.
`java.lang.String[]`	`str1`
`java.lang.String[]`	`str2`
`java.lang.String[]`	`str3`
`double`	`timeInterval` This is the time interval in seconds between generated timestamps.
`boolean`	`useTimestamps` This defaults to true so that a timestamp column is added for each row.
`int`	`xColumnDataType` A choice of integer or double values for the x-column.
`double`	`xMax` the maximum value of the x data values
`double`	`xMin` the minimum value of the x data values
`double`	`yMax` the maximum value of the y columns data values
`double`	`yMin` the minimum value of the y columns data values

Fields inherited from class com.ergotech.vib.servers.SimpleDataSource
customTimer, EXPORT_READ_ONLY, EXPORT_READ_WRITE, NO_EXPORT, requiresSyncWrite, sharedTimer, syncWriteTimeout, timebase

Fields inherited from class com.ergotech.vib.servers.DataSource
autoSuspend, AUTOSUSPEND_DEFAULT, AUTOSUSPEND_NEVER, AUTOSUSPEND_NO_LISTENERS, AUTOSUSPEND_NO_LISTENERS_AND_NO_SOURCES, colorHi, colorHiHi, colorLo, colorLoLo, colorNormal, connectors, consoleLogger, currentColor, currentValue, debugLevel, dontConnect, gwtLog, hardSuspended, popupLogger, PRIMARYOUTPORTNAME, sendColors, stopped, suspended, timedPopupLogger, traceLogger, valueHi, valueHiHi, valueLo, valueLoLo

Constructor Summary

Constructors
Constructor and Description

TwoDimensionalDataSource()
Constructor

Constructors
Constructor and Description
`TwoDimensionalDataSource()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getBooleanValue()` This will return a random 0 or 1
`int`	`getBooleanYColumns()` Gets number of boolean columns to generate
`int`	`getDoubleYColumns()` Gets number of double value columns to generate
`int`	`getIntYColumns()` Gets number of int value columns to generate
`double`	`getNumericValue(double min, double max)` This will return a random number between min and max.
`boolean`	`getRandomX()` Gets whether or not to use random or seqencial X values.
`int`	`getRows()` Gets the number of rows to be generated
`java.lang.String`	`getStringValue()` Sets the string value of the current value object.
`int`	`getStringYColumns()` Gets number of int value columns to generate
`double`	`getTimeInterval()` Gets the time interval for the X column.
`ValueObjectInterface`	`getTimestampedValues()` This will return a generated timestamped TwoDimensionalValueObject.
`boolean`	`getUseTimestamps()` gets whether or not we are using a timestamped 2DVO
`int`	`getXColumnDataType()` Returns the data type for the x column.
`double`	`getXMax()` Gets the maximum for for the X column data
`double`	`getXMin()` Gets the minimum for for the X column data
`ValueObjectInterface`	`getXYValues()` This will return a non-timestamped single X, multiple Y TwoDimensionalValueObject
`double`	`getYMax()` Gets the maximum for for the Y column data
`double`	`getYMin()` Gets the minimum for for the Y column data
`java.lang.String`	`randStr1()`
`java.lang.String`	`randStr2()`
`java.lang.String`	`randStr3()`
`void`	`refreshCurrentValue()` This is called every timebase tick to create a new ValueObject and update connectors.
`void`	`setBooleanYColumns(int booleanColumns)` Sets how many boolean columns to generate.
`void`	`setDoubleYColumns(int doubleColumns)` Sets how many double value columns to generate.
`void`	`setIntYColumns(int intColumns)` Sets how many int value columns to generate.
`void`	`setRandomX(boolean randomX)` sets whether or not to use random (the default) or seqencial X values.
`void`	`setRows(int rows)` Sets the number of rows to be generated.
`void`	`setStringYColumns(int stringColumns)` Sets how many String value columns to generate.
`void`	`setTimeInterval(double timeInterval)` Sets the time interval for the x column data.
`void`	`setUseTimestamps(boolean useTimestamps)` sets whether or not to create a timestamped 2DVO
`void`	`setXColumnDataType(int xColumnDataType)` Sets the data type for the x column (first column of the value object) The types are 0 = timestamp, 1 = int, and 2 = double.
`void`	`setXMax(double xMax)` Sets the maximum for the X column data
`void`	`setXMin(double xMin)` Sets the minimum for the X column data
`void`	`setYMax(double yMax)` Sets the maximum for the Y column data
`void`	`setYMin(double yMin)` Sets the minimum for the Y column data
`java.lang.String`	`toString()` Provides the description and status of the server as a String.

Methods inherited from class com.ergotech.vib.servers.SimpleDataSource
addConnector, addConnector, addDataSource, addPropertyChangeListener, addValueChangedListener, addVetoableChangeListener, authenticatedClientRequest, clientRequest, clientResponse, destroy, determineSuspendedStatus, getClassLicenseManager, getContainer, getCustomTimer, getDataSource, getDataSources, getDisplayName, getExportCriteria, getName, getOutPortNames, getPullFromServers, getPushData, getPushName, getPushToServers, getServerListData, getTimebase, getTrace, isActive, isScreenLocal, removeConnector, removeDataSource, removePropertyChangeListener, removeValueChangedListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setContainer, setCustomTimer, setDataSourceName, setExportCriteria, setName, setPullFromServers, setPushData, setPushName, setPushToServers, setScreenLocal, setServerListData, setTimebase, setTrace, setValueObject, start, stop, tick, VIBEvent

Methods inherited from class com.ergotech.vib.servers.DataSource
addVIBEventListener, checkScript, executeInScriptInternal, executeScript, executeScriptInternal, executeScriptInternal, getAutoSuspend, getBoolValue, getColorHi, getColorHiHi, getColorLo, getColorLoLo, getColorNormal, getConnectors, getConsoleLogger, getCurrentColor, getDataSourceName, getDoubleValue, getFloatValue, getGWTLogger, getIncomingValueObject, getInScript, getIntValue, getLongValue, getParent, getPopupLogger, getScript, getSendColors, getSources, getSyncWriteTimeout, getTimedPopupLogger, getTraceLogger, getValueHi, getValueHiHi, getValueLo, getValueLoLo, getValueObject, init, isHardSuspended, isRunning, isSendOnlyChangedValuesDefault, isSuspended, logException, logGWT, logGWT, logMessage, logTrace, n2sortConnectors, popupMessage, post, removeConnector, removeVIBEventListener, replaceConnectors, scriptExtensionSubstition, setColorHi, setColorHiHi, setColorLo, setColorLoLo, setColorNormal, setConsoleLogger, setGWTLogger, setHardSuspended, setInScript, setParent, setPopupLogger, setScript, setSendColors, setSendOnlyChangedValuesDefault, setSyncWriteTimeout, setTimedPopupLogger, setTraceLogger, setValueHi, setValueHiHi, setValueLo, setValueLoLo, updateColor, updateListeners, updateListeners, updateListeners, whoAmI

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

- Field Detail
  - booleanYColumns
```
public int booleanYColumns
```
    if set to a non-zero value, this number of boolean columns will be generated.
  - columns
```
public int columns
```
    Number of columns. Two is the default and minimum (one x and one y).
  - constantXSpacing
```
public boolean constantXSpacing
```
    If set to false the numeric spacing between the x-column values will not be even. The random spacing for each row will be an average around the selected interval.
  - doubleYColumns
```
public int doubleYColumns
```
    if set to a non-zero value, this number of double value columns will be generated.
  - randomX
```
public boolean randomX
```
    This is the whether or not to use random (true) or sequential x values.
  - rows
```
public int rows
```
    The number of rows
  - sortedX
```
public boolean sortedX
```
    This defaults to true so that the X Column data is sorted from low to high.
  - str1
```
public java.lang.String[] str1
```
  - str2
```
public java.lang.String[] str2
```
  - str3
```
public java.lang.String[] str3
```
  - timeInterval
```
public double timeInterval
```
    This is the time interval in seconds between generated timestamps.
  - useTimestamps
```
public boolean useTimestamps
```
    This defaults to true so that a timestamp column is added for each row. The timeInterval value is used to set the time interval spacing
  - xColumnDataType
```
public int xColumnDataType
```
    A choice of integer or double values for the x-column.
  - xMax
```
public double xMax
```
    the maximum value of the x data values
  - xMin
```
public double xMin
```
    the minimum value of the x data values
  - yMax
```
public double yMax
```
    the maximum value of the y columns data values
  - yMin
```
public double yMin
```
    the minimum value of the y columns data values
- Constructor Detail
  - TwoDimensionalDataSource
```
public TwoDimensionalDataSource()
```
    Constructor
- Method Detail
  - getBooleanValue
```
public boolean getBooleanValue()
```
    This will return a random 0 or 1
    
    Overrides:
    
    getBooleanValue in class DataSource
  - getBooleanYColumns
```
public int getBooleanYColumns()
```
    Gets number of boolean columns to generate
  - getDoubleYColumns
```
public int getDoubleYColumns()
```
    Gets number of double value columns to generate
  - getIntYColumns
```
public int getIntYColumns()
```
    Gets number of int value columns to generate
  - getNumericValue
```
public double getNumericValue(double min,
                              double max)
```
    This will return a random number between min and max.
  - getRandomX
```
public boolean getRandomX()
```
    Gets whether or not to use random or seqencial X values.
  - getRows
```
public int getRows()
```
    Gets the number of rows to be generated
  - getStringValue
```
public java.lang.String getStringValue()
```
    Description copied from class: DataSource
    
    Sets the string value of the current value object. This is getValueObject().getStringValue()
    
    Overrides:
    
    getStringValue in class DataSource
  - getStringYColumns
```
public int getStringYColumns()
```
    Gets number of int value columns to generate
  - getTimeInterval
```
public double getTimeInterval()
```
    Gets the time interval for the X column.
  - getTimestampedValues
```
public ValueObjectInterface getTimestampedValues()
```
    This will return a generated timestamped TwoDimensionalValueObject.
  - getUseTimestamps
```
public boolean getUseTimestamps()
```
    gets whether or not we are using a timestamped 2DVO
  - getXColumnDataType
```
public int getXColumnDataType()
```
    Returns the data type for the x column.
  - getXMax
```
public double getXMax()
```
    Gets the maximum for for the X column data
  - getXMin
```
public double getXMin()
```
    Gets the minimum for for the X column data
  - getXYValues
```
public ValueObjectInterface getXYValues()
```
    This will return a non-timestamped single X, multiple Y TwoDimensionalValueObject
  - getYMax
```
public double getYMax()
```
    Gets the maximum for for the Y column data
  - getYMin
```
public double getYMin()
```
    Gets the minimum for for the Y column data
  - randStr1
```
public java.lang.String randStr1()
```
  - randStr2
```
public java.lang.String randStr2()
```
  - randStr3
```
public java.lang.String randStr3()
```
  - refreshCurrentValue
```
public void refreshCurrentValue()
```
    This is called every timebase tick to create a new ValueObject and update connectors.
    
    Overrides:
    
    refreshCurrentValue in class SimpleDataSource
  - setBooleanYColumns
```
public void setBooleanYColumns(int booleanColumns)
```
    Sets how many boolean columns to generate.
  - setDoubleYColumns
```
public void setDoubleYColumns(int doubleColumns)
```
    Sets how many double value columns to generate.
  - setIntYColumns
```
public void setIntYColumns(int intColumns)
```
    Sets how many int value columns to generate.
  - setRandomX
```
public void setRandomX(boolean randomX)
```
    sets whether or not to use random (the default) or seqencial X values.
  - setRows
```
public void setRows(int rows)
```
    Sets the number of rows to be generated. Must be at least 1.
  - setStringYColumns
```
public void setStringYColumns(int stringColumns)
```
    Sets how many String value columns to generate.
  - setTimeInterval
```
public void setTimeInterval(double timeInterval)
```
    Sets the time interval for the x column data.
  - setUseTimestamps
```
public void setUseTimestamps(boolean useTimestamps)
```
    sets whether or not to create a timestamped 2DVO
  - setXColumnDataType
```
public void setXColumnDataType(int xColumnDataType)
```
    Sets the data type for the x column (first column of the value object) The types are 0 = timestamp, 1 = int, and 2 = double.
  - setXMax
```
public void setXMax(double xMax)
```
    Sets the maximum for the X column data
  - setXMin
```
public void setXMin(double xMin)
```
    Sets the minimum for the X column data
  - setYMax
```
public void setYMax(double yMax)
```
    Sets the maximum for the Y column data
  - setYMin
```
public void setYMin(double yMin)
```
    Sets the minimum for the Y column data
  - toString
```
public java.lang.String toString()
```
    Provides the description and status of the server as a String.
    
    Overrides:
    
    toString in class SimpleDataSource
    
    Returns:
    
    a string description of this server

Class TwoDimensionalDataSource

Nested Class Summary

Nested classes/interfaces inherited from class com.ergotech.vib.servers.SimpleDataSource

Nested classes/interfaces inherited from class com.ergotech.vib.servers.DataSource

Field Summary

Fields inherited from class com.ergotech.vib.servers.SimpleDataSource

Fields inherited from class com.ergotech.vib.servers.DataSource

Constructor Summary

Method Summary

Methods inherited from class com.ergotech.vib.servers.SimpleDataSource

Methods inherited from class com.ergotech.vib.servers.DataSource

Methods inherited from class java.lang.Object

Field Detail

booleanYColumns

columns

constantXSpacing

doubleYColumns

randomX

rows

sortedX

str1

str2

str3

timeInterval

useTimestamps

xColumnDataType

xMax

xMin

yMax

yMin

Constructor Detail

TwoDimensionalDataSource

Method Detail

getBooleanValue

getBooleanYColumns

getDoubleYColumns

getIntYColumns

getNumericValue

getRandomX

getRows

getStringValue

getStringYColumns

getTimeInterval

getTimestampedValues

getUseTimestamps

getXColumnDataType

getXMax

getXMin

getXYValues

getYMax

getYMin

randStr1

randStr2

randStr3

refreshCurrentValue

setBooleanYColumns

setDoubleYColumns

setIntYColumns

setRandomX

setRows

setStringYColumns

setTimeInterval

setUseTimestamps

setXColumnDataType

setXMax

setXMin

setYMax

setYMin

toString