com.ergotech.vib.manipulators

Class Counter

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

public class Counter
extends SimpleManipulator

This manipulator will increase its current integer value by the incrementAmount when triggered, if counting up, until it reaches its maximum. It can be cleared to 0. If counting down, it will count from its current value down to the minimum. It also has a status output: 0 OK (value in range), -1 current value at minimum or too low, +1 current value at maximum or higher. It also can reset its counter back to the minimum and continue counting up if the value exceeds the maxLimit (if counting up) or roll to the maximum value and count down if counting down, if the autoReset is set to true.

Specification: The Counter has two modes: countUp=true (default) or countUp=false (it will decrement). If counting up this manipulator adds the incrementAmount to its current integer value every time a trigger event is received at the valueInput input. The counter will stop once its current value would exceed the maximum unless autoReset is true. The counter starts at its minium value (0 by default), but a startValue can be used to set its current value. Changing the startValue forces an immediate value update.

When counting down, the counter starts at the maximum value and counts down to the minimum value. If autoReset is true, it will go back to the maximum value once the current value will be less than the minimum, and continue counting down every trigger tick.

The current value will initialize to startValue when the Counter first starts. Thereafter, the Counter will increment to maximum. If autoReset is set to true, the Counter will reset back to minium (if counting up) or to the maximum (if counting down) and begin counting again.

Clear always sets the current value to the minimum if countUp is true and to the maximum if countUp is false.

The status output can be used to indicate when the counter has reached its maximum (1) or minimum (-1) count. Normally, while it is in the minimum to maximum range, the output of the status is 0. If counting up the status will be 1 when it has reached the maximim, and similarly, if counting down the status will be -1 when it has reached the minimum value.

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 long	serialVersionUID

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

Method Summary

Modifier and Type	Method and Description
void	clear(ValueChangedEvent newEvent) The value changed method to clear the Counter (resets to minimum or maximum).
boolean	getAutoReset()
boolean	getCountUp()
long	getIncrementAmount() This gets the current increment value
long	getMaximum() This gets maximum limit
long	getMinimum() This gets the minimum
long	getStartValue() This gets the value that is set when the Counter starts
int	getStaticLocationFor(java.lang.String method) This is used by the StaticMethodEvent to determine which valueChanged method to call.
void	setAutoReset(boolean autoReset)
void	setCountUp(boolean countUp)
void	setIncrementAmount(int incrementAmount)
void	setIncrementAmount(long incrementAmount) This sets the int value to increment by.
void	setMaximum(int maximum)
void	setMaximum(long maximum) This sets the minimum (and clear value if the counter is incrementing).
void	setMinimum(int minimum)
void	setMinimum(long minimum) This sets the minimum (and clear value if the counter is incrementing).
void	setStartValue(int startValue)
void	setStartValue(long startValue) This sets the current value immediately.
java.lang.String	toString() Provides a description of the current values and states.
void	trigger(ValueChangedEvent newEvent) Increment the current value if it is counting up, or decrement it if it is counting down.
void	update(ValueObjectInterface triggerValue) Update called whenever output is needed.
void	valueChanged(int methodIndex, ValueChangedEvent e) This calls the proper valueChanged method based on the return from the getStaticLocationFor method.

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

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

Counter

public Counter()

Generic Constructor.

Method Detail

clear

public void clear(ValueChangedEvent newEvent)
           throws VIBUpdateFailedException

The value changed method to clear the Counter (resets to minimum or maximum).

Throws:

VIBUpdateFailedException

getAutoReset

public boolean getAutoReset()

getCountUp

public boolean getCountUp()

getIncrementAmount

public long getIncrementAmount()

This gets the current increment value

Returns:

int value to increment (or decrement) by

getMaximum

public long getMaximum()

This gets maximum limit

Returns:

long maximum

getMinimum

public long getMinimum()

This gets the minimum

Returns:

long minimum

getStartValue

public long getStartValue()

This gets the value that is set when the Counter starts

Returns:

startValue the starting value

getStaticLocationFor

public int getStaticLocationFor(java.lang.String method)
                         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

setAutoReset

public void setAutoReset(boolean autoReset)

setCountUp

public void setCountUp(boolean countUp)

setIncrementAmount

public void setIncrementAmount(int incrementAmount)

setIncrementAmount

public void setIncrementAmount(long incrementAmount)

This sets the int value to increment by. Must be a positive number or will be set to 0.

Parameters:

incrementAmount -

setMaximum

public void setMaximum(int maximum)

setMaximum

public void setMaximum(long maximum)

This sets the minimum (and clear value if the counter is incrementing).

Parameters:

maximum - the minimum value for the Counter

setMinimum

public void setMinimum(int minimum)

setMinimum

public void setMinimum(long minimum)

This sets the minimum (and clear value if the counter is incrementing).

Parameters:

minimum - the minimum value for the Counter

setStartValue

public void setStartValue(int startValue)
                   throws VIBUpdateFailedException

Throws:

VIBUpdateFailedException

setStartValue

public void setStartValue(long startValue)
                   throws VIBUpdateFailedException

This sets the current value immediately. No check is made to see if it is outside the minimum to maximum range. The counter will start from this value the next time it is triggered.

Throws:

VIBUpdateFailedException

toString

public java.lang.String toString()

Provides a description of the current values and states.

Overrides:

toString in class Manipulator

Returns:

a string description of this server

trigger

public void trigger(ValueChangedEvent newEvent)
             throws VIBUpdateFailedException

Increment the current value if it is counting up, or decrement it if it is counting down. The only check is if it would exceed the maximum or go lower than the minimum. If either one of these cases is true, and autoReset is false, then no output is generated.

Throws:

VIBUpdateFailedException

update

public void update(ValueObjectInterface triggerValue)
            throws VIBUpdateFailedException

Update called whenever output is needed.

Throws:

VIBUpdateFailedException

valueChanged

public void valueChanged(int methodIndex,
                         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