com.ergotech.vib.manipulators

Class Subtract

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.MasterCalculator

com.ergotech.vib.manipulators.Subtract

public class Subtract
extends MasterCalculator

Calculates the difference of two numbers. Specification This manipulator has a main value input and a subtraction input to use to produce the result: (mainValue - subtractionValue). If both inputs are Longs or both are Integers then the output is a Long, otherwise it is a Double. Both inputs are required to produce an output. In other words, if only one input connector has changed (ever), no output value will be generated. An output is generated each time either the main input or the subtraction input is received. The output data quality will be the worse of the two input's quality. Properties will be combined in the output value object. The inputs' Color values are ignored. If one or more of the inputs are Strings, they are converted to a Double unless they can be converted to a Long. If the String does not convert to a number, a Runtime Exception is thrown and the offending input value is logged, and the last value is sent out with quality BAD.

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
static java.lang.String	cvsRev

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

descriptions, operation, secondValue, value

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
Subtract() Constructor.

Method Summary

Modifier and Type	Method and Description
int	getStaticLocationFor(java.lang.String loc) This is used by the StaticMethodEvent to determine which valueChanged method to call.
void	subtractionValueInput(ValueChangedEvent newEvent) This is the input method for the value that is to be subtracted from the main input.
java.lang.String	toString() Provides the description and status of the server as a String.
void	valueChanged(int loc, ValueChangedEvent e) This calls the proper valueChanged method based on the return from the getStaticLocationFor method.

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

checkValidValue, update, valueInput

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

getDefaultQualityForLocation

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

getInPortNames, setBooleanValue, setBoolValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue

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, refreshCurrentValue, removeConnector, removeDataSource, removePropertyChangeListener, removeValueChangedListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setContainer, setCustomTimer, setDataSourceName, setExportCriteria, setExposeComponentConnections, 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, 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

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

Constructor Detail

Subtract

public Subtract()

Constructor. This sets the Master Calculator operation to SUBTRACT.

Method Detail

getStaticLocationFor

public int getStaticLocationFor(java.lang.String loc)
                         throws BadParameterException

This is used by the StaticMethodEvent to determine which valueChanged method to call. An integer index is returned which is used by the valueChanged (int,ValueChangedEvent) method.

Overrides:

getStaticLocationFor in class MasterCalculator

Throws:

BadParameterException

subtractionValueInput

public void subtractionValueInput(ValueChangedEvent newEvent)
                           throws VIBUpdateFailedException

This is the input method for the value that is to be subtracted from the main input. The ValueObject in the ValueChangedEvent is expected to be convertable to a number.

Parameters:

newEvent - an event from the registered data source

Throws:

VIBUpdateFailedException

See Also:

MasterCalculator.secondValueInput(ValueChangedEvent), MasterCalculator.valueInput(ValueChangedEvent)

toString

public java.lang.String toString()

Provides the description and status of the server as a String.

Overrides:

toString in class Manipulator

Returns:

a string description of this server

valueChanged

public void valueChanged(int loc,
                         ValueChangedEvent e)
                  throws VIBUpdateFailedException,
                         BadParameterException

This calls the proper valueChanged method based on the return from the getStaticLocationFor method.

Overrides:

valueChanged in class MasterCalculator

Throws:

VIBUpdateFailedException

BadParameterException