com.ergotech.vib.servers

Class FloatFluxServer

java.lang.Object

com.ergotech.vib.servers.DataSource

com.ergotech.vib.servers.SimpleDataSource

com.ergotech.vib.servers.FloatFluxServer

public class FloatFluxServer
extends SimpleDataSource

This is a data source for testing components that generates a float value. It generates a randomly "fluctuating" value around the "level" setting, starting at the "startLevel" value, which defaults to 0. When the current value is above or below the level setting, it will change its value to approach the "level" setting. The amplitude of the fluctuations is controlled by the "Max Fluctuation" value and the rate at which it reaches the level is controled by the "Rate" setting. Specification: This starts at the startLevel when instantiated and fluctuates to the Level setting. Whenever a Level is changed, it starts at the current value and fluctuates to the new Level setting. When the current value is within the Max Fluctuation value, it will stop approaching and fluctuate around the Level. It is possible that the caluculation for the next value will take the current value outside the Level +/- the Max Fluctuation value, in which case it will go into the approach mode again until the value is stabalized to a value within the Level +/- the Max Value.

Note: Setting the Level, Max Fluctuation, or Rate will not take effect until the next calculation is made (when the timebase ticks the next time). If the startLevel is changed, this will take effect immediately.

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
float	level The target level.
float	maxFluctuation The maximum (small) fluctuation when at the target level.
float	rate The maximum change at each timebase tick to change the value when approaching the level.
float	startLevel The target level.

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

Constructor Summary

Constructors

Constructor and Description
FloatFluxServer() Constructor.

Method Summary

Modifier and Type	Method and Description
float	getLevel() Returns the current level value.
float	getMaxFluctuation() Returns the current maximum fluctuation level of the server.
float	getRate() Returns the Rate of change value.
float	getStartLevel() Returns the default starting level of this server, which defaults to 0.
void	refreshCurrentValue() Sets the new calculated value.
void	setLevel(float newValue) Sets the target level of the server.
void	setMaxFluctuation(float newValue) Sets the current maximum fluctuation level of the server.
void	setRate(float newValue) Sets the Rate of change for the server.
void	setStartLevel(float startLevel) Sets the start-up level of the server.
java.lang.String	toString() Provides the description and status of the server as a String.

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, getName, getOutPortNames, getPullFromServers, getPushData, getPushName, getPushToServers, getServerListData, getTimebase, getTrace, isActive, isScreenLocal, removeConnector, removeDataSource, removePropertyChangeListener, removeValueChangedListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setContainer, setCustomTimer, setDataSourceName, setExportCriteria, 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, getSendColors, getSources, getStringValue, getSyncWriteTimeout, getTimedPopupLogger, getTraceLogger, getValueHi, getValueHiHi, getValueLo, getValueLoLo, getValueObject, init, isHardSuspended, isRunning, isSendOnlyChangedValuesDefault, isSuspended, logException, logGWT, logGWT, logMessage, logTrace, n2sortConnectors, 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

level

public float level

The target level.

maxFluctuation

public float maxFluctuation

The maximum (small) fluctuation when at the target level.

rate

public float rate

The maximum change at each timebase tick to change the value when approaching the level.

startLevel

public float startLevel

The target level.

Constructor Detail

FloatFluxServer

public FloatFluxServer()

Constructor. This sets the Level to 50, the Max Fluctuations to 1.0, the Rate to 6.0, and the timebase to 0.5.

Method Detail

getLevel

public float getLevel()

Returns the current level value.

Returns:

the target level

See Also:

Writing VIB Data Sources: Get/Set Methods, setLevel(float)

getMaxFluctuation

public float getMaxFluctuation()

Returns the current maximum fluctuation level of the server.

Returns:

the maximum fluctuation setting.

See Also:

Writing VIB Data Sources: Get/Set Methods, setMaxFluctuation(float)

getRate

public float getRate()

Returns the Rate of change value.

Returns:

the rate setting.

See Also:

Writing VIB Data Sources: Get/Set Methods, setRate(float)

getStartLevel

public float getStartLevel()

Returns the default starting level of this server, which defaults to 0.

Returns:

the float start-up level

See Also:

setStartLevel(float)

refreshCurrentValue

public void refreshCurrentValue()

Sets the new calculated value. This is called every timebase tick.
This server uses the formula:

    newValue =  +random(0-1) or -random(0-1) previous value

with a change in value dependent on whether or not the target level has been reached yet.

Overrides:

refreshCurrentValue in class SimpleDataSource

setLevel

public void setLevel(float newValue)

Sets the target level of the server.

Parameters:

newValue - the new target level.

See Also:

Writing VIB Data Sources: Get/Set Methods, getLevel()

setMaxFluctuation

public void setMaxFluctuation(float newValue)

Sets the current maximum fluctuation level of the server.

Parameters:

newValue - the new maximum fluctuation value.

See Also:

Writing VIB Data Sources: Get/Set Methods, getMaxFluctuation()

setRate

public void setRate(float newValue)

Sets the Rate of change for the server.

Parameters:

newValue - the new rate value.

See Also:

Writing VIB Data Sources: Get/Set Methods, getRate()

setStartLevel

public void setStartLevel(float startLevel)

Sets the start-up level of the server. This defaults to 0. When changed this will take effect immediately (all listeners are updated with this value).

Parameters:

startLevel - the default startup level.

See Also:

getStartLevel()

toString

public java.lang.String toString()

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

Overrides:

toString in class SimpleDataSource

Returns:

a string description of this server