com.ergotech.vib.manipulators

Class Manipulator

java.lang.Object

com.ergotech.vib.servers.DataSource

com.ergotech.vib.servers.SimpleDataSource

com.ergotech.vib.manipulators.Manipulator

Direct Known Subclasses:

LocalEquipmentConfig, LocalSecurityManager, ModbusSlaveBase, SimpleManipulator

public abstract class Manipulator
extends SimpleDataSource

This is the superclass of servers and components that generated data and can be written to. This add the StaticConnectorDiscoveryInterface interface to SimpleDataSource so that the server has an input. This contrasts with servers, such as the SineServer, or Constant that are subclasses of SimpleDataSource and don't have an input. Connectors made to this server will send only changed values (by default) and the auto suspend condition is (by default) autosuspend on no listeners and no sources. The beans will send colors by default. Connectors into these objects will pass only quality good values (by default).

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	UPDATE_DISPLAYED_VALUE The name of the primary input method.
static java.lang.String	VALUE_INPUT The name of the primary input method.

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

Method Summary

Modifier and Type	Method and Description
int	getDefaultQualityForLocation(int location) For any location returns QUALITY_GOOD meaning that values must be good to pass.
java.util.Enumeration<java.lang.String>	getInPortNames() This will return a Enumeration of Strings which are associated with an inport.
int	getStaticLocationFor(java.lang.String method) This is the default getStaticLocationFor with a location used by the staticmethodevent to find a specific entry value object.
void	setBooleanValue(boolean b) Sets the boolean value of the current value object.
void	setBoolValue(boolean b) Sets the boolean value of the current value object.
void	setByteValue(byte b) Sets the byte value of the current value object.
void	setDoubleValue(double d) Sets the double value of the current value object.
void	setFloatValue(float f) Sets the float value of the current value object.
void	setIntValue(int i) Sets the int value of the current value object.
void	setLongValue(long l) Sets the long value of the current value object.
void	setShortValue(short s) Sets the short value of the current value object.
void	setStringValue(java.lang.String s) Sets the string value of the current value object.
java.lang.String	toString() Provides the description and status of the server as a String.
void	valueChanged(int loc, ValueChangedEvent e) This is the default valuechanged with a location used by the staticmethodevent to find a specific entry value object.
void	valueInput(ValueChangedEvent newEvent) This method is called by beans and other data sources to set the value of this server.

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

UPDATE_DISPLAYED_VALUE

public static final java.lang.String UPDATE_DISPLAYED_VALUE

The name of the primary input method.

See Also:

Constant Field Values

VALUE_INPUT

public static final java.lang.String VALUE_INPUT

The name of the primary input method.

See Also:

Constant Field Values

Constructor Detail

Manipulator

public Manipulator()

Generic constructor.

Method Detail

getDefaultQualityForLocation

public int getDefaultQualityForLocation(int location)
                                 throws BadParameterException

For any location returns QUALITY_GOOD meaning that values must be good to pass.

Parameters:

location - the method index.

Throws:

BadParameterException - never thrown.

getInPortNames

public java.util.Enumeration<java.lang.String> getInPortNames()

This will return a Enumeration of Strings which are associated with an inport.

See Also:

addInPortName(String), getInPortNames()

getStaticLocationFor

public int getStaticLocationFor(java.lang.String method)
                         throws BadParameterException

This is the default getStaticLocationFor with a location used by the staticmethodevent to find a specific entry value object. This will return 0 every time.

Throws:

BadParameterException

setBooleanValue

public void setBooleanValue(boolean b)
                     throws VIBUpdateFailedException

Sets the boolean value of the current value object. This is setValueObject(new LongValueObject(b));

Throws:

VIBUpdateFailedException - thrown if setValueObject throws

setBoolValue

public void setBoolValue(boolean b)
                  throws VIBUpdateFailedException

Sets the boolean value of the current value object. This is setBooleanValue(b)

Throws:

VIBUpdateFailedException - thrown if setValueObject throws

setByteValue

public void setByteValue(byte b)
                  throws VIBUpdateFailedException

Sets the byte value of the current value object. This is setValueObject(new LongValueObject(s));

Throws:

VIBUpdateFailedException - thrown if setValueObject throws

setDoubleValue

public void setDoubleValue(double d)
                    throws VIBUpdateFailedException

Sets the double value of the current value object. This is setValueObject(new DoubleValueObject(d));

Throws:

VIBUpdateFailedException - thrown if setValueObject throws

setFloatValue

public void setFloatValue(float f)
                   throws VIBUpdateFailedException

Sets the float value of the current value object. This is setValueObject(new DoubleValueObject(f));

Throws:

VIBUpdateFailedException - thrown if setValueObject throws

setIntValue

public void setIntValue(int i)
                 throws VIBUpdateFailedException

Sets the int value of the current value object. This is setValueObject(new LongValueObject(i));

Throws:

VIBUpdateFailedException - thrown if setValueObject throws

setLongValue

public void setLongValue(long l)
                  throws VIBUpdateFailedException

Sets the long value of the current value object. This is setValueObject(new LongValueObject(l));

Throws:

VIBUpdateFailedException - thrown if setValueObject throws

setShortValue

public void setShortValue(short s)
                   throws VIBUpdateFailedException

Sets the short value of the current value object. This is setValueObject(new LongValueObject(s));

Throws:

VIBUpdateFailedException - thrown if setValueObject throws

setStringValue

public void setStringValue(java.lang.String s)
                    throws VIBUpdateFailedException

Sets the string value of the current value object. This is setValueObject(new StringValueObject(s));

Throws:

VIBUpdateFailedException - thrown if setValueObject throws

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

valueChanged

public void valueChanged(int loc,
                         ValueChangedEvent e)
                  throws VIBUpdateFailedException,
                         BadParameterException

This is the default valuechanged with a location used by the staticmethodevent to find a specific entry value object. This will call valuechanged every time.

Throws:

VIBUpdateFailedException

BadParameterException

valueInput

public void valueInput(ValueChangedEvent newEvent)
                throws VIBUpdateFailedException

This method is called by beans and other data sources to set the value of this server. setValueObject is called.

Parameters:

newEvent - The ValueChangedEvent that the bean or data source has sent.

Throws:

VIBUpdateFailedException