com.ergotech.vib.manipulators

Class MasterBooleanCalculator

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

Direct Known Subclasses:

And, Not, Or, Xor

public class MasterBooleanCalculator
extends SimpleManipulator

This is a superclass for AND, OR, NOT,and XOR. Specification This manipulator is a super class for AND, OR, NOT, and XOR. This manipulator takes two inputs (which must covert to a boolean value) and the a specific boolean operation will be called. 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 inputs are converted to boolean (non-zero = True, zero = False). The inputs must be convertable to a Long. This includes whole numbers, decimal numbers with only zeros in the fractional part, and Strings that are convertible. If the String does not convert to a number, the last value is sent out with quality BAD and a Runtime Exception is thrown. The offending input value is also logged.

The output is a Boolean (LongValueObject). The output data quality will be the worse of the two input's quality. The Color will be set with the Boolean True and Boolean False color states. Properties of the two inputs will be combined in the value output. The inputs' Color values are ignored.

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 secondValueChanged input.
ValueObjectInterface	value This is the input value received at the valueChanged input.

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

Method Summary

Modifier and Type	Method and Description
ValueObjectInterface	checkValidValue(ValueObjectInterface newValue) This is used to check that only boolean values may be used.
int	getStaticLocationFor(java.lang.String loc) This is used by the StaticMethodEvent to determine which valueChanged method to call.
void	setColorHiHi(java.awt.Color newColor) Sets the true color.
void	setColorLoLo(java.awt.Color newColor) Sets the false color.
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, setColorLo, 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 secondValueChanged input.

value

public transient ValueObjectInterface value

This is the input value received at the valueChanged input.

Constructor Detail

MasterBooleanCalculator

public MasterBooleanCalculator()

Generic Constructor.

Method Detail

checkValidValue

public ValueObjectInterface checkValidValue(ValueObjectInterface newValue)
                                     throws VIBUpdateFailedException

This is used to check that only boolean values may be used. The ValueObject from the input is passed here for conversion. If the value does not convert to a Boolean, (such as a String that does not convert to a number) then a NumberFormatException is thrown.

Returns:

the LongValueObject containing the Boolean value

Throws:

java.lang.NumberFormatException

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

setColorHiHi

public void setColorHiHi(java.awt.Color newColor)

Sets the true color. Makes sure that when the HiHi color is set, that the Hi color is also set to the same value.

Overrides:

setColorHiHi in class DataSource

Parameters:

newColor - the new High level server color

See Also:

DataSource.getColorHiHi(), DataSource.getValueHiHi(), DataSource.setValueHiHi(double)

setColorLoLo

public void setColorLoLo(java.awt.Color newColor)

Sets the false color. Makes sure that when the LoLo color is set, that the Lo color is also set to the same value.

Overrides:

setColorLoLo in class DataSource

Parameters:

newColor - the new Low level server color

See Also:

DataSource.getColorLoLo(), DataSource.getValueLoLo(), DataSource.setValueLoLo(double)

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(), secondBooleanInput(ValueChangedEvent)