com.ergotech.vib.manipulators

Class Constant

java.lang.Object

com.ergotech.vib.servers.DataSource

com.ergotech.vib.servers.SimpleDataSource

com.ergotech.vib.manipulators.Constant

All Implemented Interfaces:

ConstantSimulationListener, SimulationListener

Direct Known Subclasses:

StartupTrigger

public class Constant
extends SimpleDataSource
implements ConstantSimulationListener

This is a simple ValueObject creating component. Specification: This component is a simple server that sends out a constant ValueObject when started. It has options to add a Color and non-good quality to the generated ValueObject. This manipulator always fires sometime during the initialization of the logic, not necessarily in any order (see StartupTrigger for a constant that is sent at the end of all other initialization).

See Also:

StartupTrigger

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.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
Constant() constructor

Method Summary

Modifier and Type	Method and Description
void	addConnector(Connector connector) Adds an input Connector to this component from the primary outport of a data source.
java.lang.String	getConstantValue()
int	getInitialQuality()
int	getType()
boolean	isFireLate() This must be implemented to determine the firing order of the constants.
void	refreshCurrentValue() Called on the timebase and sends the current value.
void	sendValue() This will start the server, sending the value.
void	setColorHi(java.awt.Color newColor) Overridden to send the value when changed.
void	setConstantValue(java.lang.String constantValue)
void	setFireLate(boolean fireLate)
void	setInitialQuality(int initialQuality)
void	setSimulationFlag(boolean simulationFlag) This is ignored.
void	setType(int type)
void	simulationStateChanged(SimulationChangedEvent simulationChangedEvent) Called when the simulation state changes.
void	start() This will start the server, sending the value.
ValueObjectInterface	updateColor(ValueObjectInterface newValueObject) The superclass sets the color according to values/levels which is not what we want for this component.

Methods inherited from class com.ergotech.vib.servers.SimpleDataSource

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, removeConnector, removeDataSource, removePropertyChangeListener, removeValueChangedListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setContainer, setCustomTimer, setDataSourceName, setExportCriteria, setExposeComponentConnections, setName, setPullFromServers, setPushData, setPushName, setPushToServers, setScreenLocal, setServerListData, setTimebase, setTrace, setValueObject, stop, tick, toString, 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, setColorHiHi, setColorLo, setColorLoLo, setColorNormal, setConsoleLogger, setGWTLogger, setHardSuspended, setInScript, setParent, setPopupLogger, setScript, setSendColors, setSendOnlyChangedValuesDefault, setSyncWriteTimeout, setTimedPopupLogger, setTraceLogger, setValueHi, setValueHiHi, setValueLo, setValueLoLo, 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

Constant

public Constant()

constructor

Method Detail

addConnector

public void addConnector(Connector connector)
                  throws BadParameterException,
                         VIBUpdateFailedException

Adds an input Connector to this component from the primary outport of a data source. If the component is not screen local then the connector will be updated with the current value of the object.

Overrides:

addConnector in class SimpleDataSource

Parameters:

connector - the connector to be added.

Throws:

BadParameterException - if the targetMethodName does not exist in the listener, or is not

VIBUpdateFailedException - if an update of the connector (by a subclass of this object) fails.

See Also:

#removeaddConnector

getConstantValue

public java.lang.String getConstantValue()

Returns:

Returns the constantValue.

getInitialQuality

public int getInitialQuality()

Returns:

Returns the initialQuality.

getType

public int getType()

Returns:

Returns the type.

isFireLate

public boolean isFireLate()

Description copied from interface: ConstantSimulationListener

This must be implemented to determine the firing order of the constants. If !firelate then the constant will be triggered before any other beans. If firelate then the constant (StartupTrigger) will be triggered after all the other beans.

Specified by:

isFireLate in interface ConstantSimulationListener

Returns:

Returns the fireLate.

refreshCurrentValue

public void refreshCurrentValue()

Called on the timebase and sends the current value. The use of a constant with a timebase is questionable, but users seem confused by the idea that a constant sends a value _exactly_ once.

Overrides:

refreshCurrentValue in class SimpleDataSource

See Also:

SimpleDataSource.refreshCurrentValue()

sendValue

public void sendValue()

This will start the server, sending the value.

See Also:

com.ergotech.vib.servers.ExpectationServerInterface#initializationComplete()

setColorHi

public void setColorHi(java.awt.Color newColor)

Overridden to send the value when changed.

Overrides:

setColorHi in class DataSource

Parameters:

newColor - The new Color for the Hi range

See Also:

DataSource.setColorHi(java.awt.Color)

setConstantValue

public void setConstantValue(java.lang.String constantValue)

Parameters:

constantValue - The constantValue to set.

setFireLate

public void setFireLate(boolean fireLate)

Parameters:

fireLate - The fireLate to set.

setInitialQuality

public void setInitialQuality(int initialQuality)

Parameters:

initialQuality - The initialQuality to set.

setSimulationFlag

public void setSimulationFlag(boolean simulationFlag)

This is ignored. We don't care about the simululation state, only a transition to "not simulating".

Specified by:

setSimulationFlag in interface SimulationListener

Parameters:

simulationFlag - will be written as "false" when code is generated.

See Also:

SimulationListener.setSimulationFlag(boolean)

setType

public void setType(int type)

Parameters:

type - The type to set.

simulationStateChanged

public void simulationStateChanged(SimulationChangedEvent simulationChangedEvent)
                            throws java.lang.Exception

Called when the simulation state changes. If the simulation is moving from simulated to not simulating we will re-trigger the constants (and startup triggers).

Specified by:

simulationStateChanged in interface SimulationListener

Throws:

java.lang.Exception - TODO

start

public void start()
           throws BadParameterException,
                  VIBUpdateFailedException

This will start the server, sending the value.

Overrides:

start in class SimpleDataSource

Throws:

BadParameterException

VIBUpdateFailedException

See Also:

com.ergotech.vib.servers.ExpectationServerInterface#initializationComplete()

updateColor

public ValueObjectInterface updateColor(ValueObjectInterface newValueObject)

The superclass sets the color according to values/levels which is not what we want for this component. This returns the ValueObject with the correct color set (or not) depending on if sendColors is true or not.

Overrides:

updateColor in class DataSource