PidControl (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.vib.servers.DataSource
- - com.ergotech.vib.servers.SimpleDataSource
  - - com.ergotech.vib.manipulators.Manipulator
    - - com.ergotech.vib.manipulators.SimpleManipulator
      - com.ergotech.vib.manipulators.spc.PidControl

```
public class PidControl
extends SimpleManipulator
```
Maintains the process in which the process input is manipulated in such a way that the process output value is being moved toward the given set point. The process can be tuned by using Proportional, Integral, and Derivative (PID) parameters. The class provides the bumpless adjustment when transfers from the manual control to the automode, or when the set point is changed.

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
`boolean`	`autoMode`
`double`	`CV`
`double`	`D`
`double`	`error`
`double`	`I`
`double`	`manualCommand`
`double`	`oldError`
`double`	`oldSP`
`double`	`P`
`int`	`PIDExecution`
`double`	`PV`
`double`	`SP`
`double`	`sumError`

Fields inherited from class com.ergotech.vib.manipulators.SimpleManipulator
cvsRev

Fields inherited from class com.ergotech.vib.manipulators.Manipulator
UPDATE_DISPLAYED_VALUE, VALUE_INPUT

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, DEFAULT_AUTOSUSPEND, dontConnect, gwtLog, hardSuspended, popupLogger, PRIMARYOUTPORTNAME, sendColors, stopped, suspended, timedPopupLogger, traceLogger, valueHi, valueHiHi, valueLo, valueLoLo

Constructor Summary

Constructors
Constructor and Description

PidControl()

Constructors
Constructor and Description
`PidControl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getAutoMode()` accesses the value for automode
`double`	`getD()` accesses the value for the derivative parameter
`double`	`getI()` accesses the value for the integral parameter
`double`	`getManualCommand()` accesses the value for manual command
`double`	`getOutMax()`
`double`	`getOutMin()`
`double`	`getP()` accesses the value for the proprtional parameter
`double`	`getSP()` accesses the value for the set point
`boolean`	`isBumplessControl()`
`void`	`refreshCurrentValue()` This method is called automatically by the timer in SimpleDataSource every timebase interval.
`void`	`setAutoMode(boolean mode)` sets a new boolean value for the automode
`void`	`setBumplessControl(boolean bumplessControl)`
`void`	`setD(double newD)` sets a new value for the derivative parameter
`void`	`setI(double newI)` sets a new value for the integral parameter
`void`	`setManualCommand(double manualCommand)` sets a new value for the manual command
`void`	`setOutMax(double outMax)`
`void`	`setOutMin(double outMin)`
`void`	`setP(double newP)` sets a new value for the proportional parameter
`void`	`setSP(double newSP)` sets a new value for the set point
`void`	`setValueObject(ValueObjectInterface newValue)` This method will be called from the server sending value for the process value when this value is changed.

Methods inherited from class com.ergotech.vib.manipulators.SimpleManipulator
getDefaultQualityForLocation

Methods inherited from class com.ergotech.vib.manipulators.Manipulator
getInPortNames, getStaticLocationFor, setBooleanValue, setBoolValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, toString, valueChanged, valueInput

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, getExposeComponentConnections, getName, getOutPortNames, getPullFromServers, getPushData, getPushName, getPushToServers, getServerListData, getTimebase, getTrace, isActive, isScreenLocal, removeConnector, removeDataSource, removePropertyChangeListener, removeValueChangedListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setContainer, setCustomTimer, setDataSourceName, setExportCriteria, setExposeComponentConnections, setName, setPullFromServers, setPushData, setPushName, setPushToServers, setScreenLocal, setServerListData, setTimebase, setTrace, start, stop, tick, VIBEvent

Methods inherited from class com.ergotech.vib.servers.DataSource
addVIBEventListener, checkScript, executeInScriptInternal, executeScript, executeScriptInternal, executeScriptInternal, getAutoSuspend, getBooleanValue, getBoolValue, getColorHi, getColorHiHi, getColorLo, getColorLoLo, getColorNormal, getConnectors, getConsoleLogger, getCurrentColor, getDataSourceName, getDoubleValue, getFloatValue, getGWTLogger, getIncomingValueObject, getInScript, getIntValue, getLongValue, getParent, getPopupLogger, getScript, getScriptEngine, getSendColors, getSources, getStringValue, getSyncWriteTimeout, getTimedPopupLogger, getTraceLogger, getValueHi, getValueHiHi, getValueLo, getValueLoLo, getValueObject, init, isHardSuspended, isRunning, isSendOnlyChangedValuesDefault, isSuspended, logException, logGWT, logGWT, logMessage, logTrace, n2sortConnectors, performScriptSubstitutions, 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
  - autoMode
```
public boolean autoMode
```
  - CV
```
public double CV
```
  - D
```
public double D
```
  - error
```
public double error
```
  - I
```
public double I
```
  - manualCommand
```
public double manualCommand
```
  - oldError
```
public double oldError
```
  - oldSP
```
public double oldSP
```
  - P
```
public double P
```
  - PIDExecution
```
public int PIDExecution
```
  - PV
```
public double PV
```
  - SP
```
public double SP
```
  - sumError
```
public double sumError
```
- Constructor Detail
  - PidControl
```
public PidControl()
```
- Method Detail
  - getAutoMode
```
public boolean getAutoMode()
```
    accesses the value for automode
    
    Returns:
    
    the boolean value for autoMode
  - getD
```
public double getD()
```
    accesses the value for the derivative parameter
    
    Returns:
    
    the double value for the derivative parameter
  - getI
```
public double getI()
```
    accesses the value for the integral parameter
    
    Returns:
    
    the double value for the integral parameter
  - getManualCommand
```
public double getManualCommand()
```
    accesses the value for manual command
    
    Returns:
    
    the double value for manualCommand
  - getOutMax
```
public double getOutMax()
```
  - getOutMin
```
public double getOutMin()
```
  - getP
```
public double getP()
```
    accesses the value for the proprtional parameter
    
    Returns:
    
    the double value for the proprtional parameter
  - getSP
```
public double getSP()
```
    accesses the value for the set point
    
    Returns:
    
    the double value for the set point
  - isBumplessControl
```
public boolean isBumplessControl()
```
  - refreshCurrentValue
```
public void refreshCurrentValue()
```
    This method is called automatically by the timer in SimpleDataSource every timebase interval. This adds to the current value the amount accumulated for the timebase period if the resume is true and leaves the amount unchanged otherwise.
    
    Overrides:
    
    refreshCurrentValue in class SimpleDataSource
  - setAutoMode
```
public void setAutoMode(boolean mode)
```
    sets a new boolean value for the automode
    
    Parameters:
    
    mode - the boolean value for automode
  - setBumplessControl
```
public void setBumplessControl(boolean bumplessControl)
```
  - setD
```
public void setD(double newD)
```
    sets a new value for the derivative parameter
    
    Parameters:
    
    newI - the double value for the derivative parameter
  - setI
```
public void setI(double newI)
```
    sets a new value for the integral parameter
    
    Parameters:
    
    newI - the double value for the integral parameter
  - setManualCommand
```
public void setManualCommand(double manualCommand)
```
    sets a new value for the manual command
    
    Parameters:
    
    manualCommand - the double value for the manual command
  - setOutMax
```
public void setOutMax(double outMax)
```
  - setOutMin
```
public void setOutMin(double outMin)
```
  - setP
```
public void setP(double newP)
```
    sets a new value for the proportional parameter
    
    Parameters:
    
    newP - the double value for the new proportional parameter
  - setSP
```
public void setSP(double newSP)
```
    sets a new value for the set point
    
    Parameters:
    
    newSP - the double value for the new set point
  - setValueObject
```
public void setValueObject(ValueObjectInterface newValue)
```
    This method will be called from the server sending value for the process value when this value is changed.
    
    Overrides:
    
    setValueObject in class SimpleDataSource
    
    Parameters:
    
    newEvent - the event generating a new double value
    
    See Also:
    
    ValueObject

Class PidControl

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.manipulators.SimpleManipulator

Fields inherited from class com.ergotech.vib.manipulators.Manipulator

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.manipulators.SimpleManipulator

Methods inherited from class com.ergotech.vib.manipulators.Manipulator

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

autoMode

CV

D

error

I

manualCommand

oldError

oldSP

P

PIDExecution

PV

SP

sumError

Constructor Detail

PidControl

Method Detail

getAutoMode

getD

getI

getManualCommand

getOutMax

getOutMin

getP

getSP

isBumplessControl

refreshCurrentValue

setAutoMode

setBumplessControl

setD

setI

setManualCommand

setOutMax

setOutMin

setP

setSP

setValueObject