com.ergotech.vib.manipulators

Class MasterCalculator

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

Direct Known Subclasses:

Add, BitwiseAnd, BitwiseOr, BitwiseXor, Divide, Multiply, Subtract

public class MasterCalculator
extends SimpleManipulator

This is a superclass for Add,Subtract, Multiply, and Divide, as well as the Bitwise Operations: AND, OR, XOR. Specification This manipulator is a super class for Add,Subtract,Multiply, and Divide, and the logical bitwise operations of AND, OR, and XOR. It takes two inputs which are operated together to produce a result. The specific specification for each mathematical operation is given in the documentation for the sub class. 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 any input value is received. The output may have a bad quality setting if there is anything wrong with one of the input values (does not convert to a number, for example).

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
static java.lang.String[]	descriptions Intelligent string for the defined constants.
int	operation The integer value for the requested operation.
ValueObjectInterface	secondValue This is the input value received at the secondValueInput.
ValueObjectInterface	value This is the input value received at the valueInput.

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

Method Summary

Modifier and Type	Method and Description
ValueObjectInterface	checkValidValue(ValueObjectInterface newValue) This returns a valid LongValueObject or DoubleValueObject for the input.
int	getStaticLocationFor(java.lang.String loc) This is used by the StaticMethodEvent to determine which valueChanged method to call.
void	update() This method is called whenever any input is changed.
void	valueChanged(int loc, ValueChangedEvent e) This calls the proper valueChanged method based on the return from the getStaticLocationFor method.
void	valueInput(ValueChangedEvent newEvent) This is the primary input method for the main value.

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, toString

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

descriptions

public static final java.lang.String[] descriptions

Intelligent string for the defined constants.

operation

public int operation

The integer value for the requested operation.

secondValue

public transient ValueObjectInterface secondValue

This is the input value received at the secondValueInput.

value

public transient ValueObjectInterface value

This is the input value received at the valueInput.

Constructor Detail

MasterCalculator

public MasterCalculator()

Generic Constructor.

Method Detail

checkValidValue

public ValueObjectInterface checkValidValue(ValueObjectInterface newValue)
                                     throws VIBUpdateFailedException

This returns a valid LongValueObject or DoubleValueObject for the input. The precision of the input is not washed: if the number is a Long, then it is returned as a Long. If it is a String that can be converted to a Long without loss of precision, then it is also returned as a Long. If the input does not convert to a number, then a VIBUpdateFailedException is thrown.

Returns:

the DoubleValueObject containing the numeric value

Throws:

VIBUpdateFailedException

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 Manipulator

Throws:

BadParameterException

update

public void update()
            throws VIBUpdateFailedException

This method is called whenever any input is changed. The correct operation is called to do the calculation.

Throws:

VIBUpdateFailedException

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 Manipulator

Throws:

VIBUpdateFailedException

BadParameterException

valueInput

public void valueInput(ValueChangedEvent newEvent)
                throws VIBUpdateFailedException

This is the primary input method for the main value. This can be the arbitrary first input for calculations that are not order dependent, or it can be the primary input for calculations that are order dependent. At this point no type checking of the ValueObject is made.

Overrides:

valueInput in class Manipulator

Parameters:

newEvent - an event from the registered data source

Throws:

VIBUpdateFailedException

See Also:

update(), secondValueInput(ValueChangedEvent)