com.ergotech.vib.manipulators

Class SimpleManipulator

java.lang.Object

com.ergotech.vib.servers.DataSource

com.ergotech.vib.servers.SimpleDataSource

com.ergotech.vib.manipulators.Manipulator

com.ergotech.vib.manipulators.SimpleManipulator

Direct Known Subclasses:

ArrayBuilder, ArrayElementFilter, ArraySplitter, ArrayToString, BitSelector, Blinker, BroadcastServer, ByteBuilder, ByteSplitter, CodeToString, CombineStrings, CommandExecutor, ConnectionConfig, ConvertFromHex, ConvertToHex, Counter, DataValve, DateCreator, DateInfo, DateToLong, DecimalFormatter, DeviceManagerManipulator, Emailer, FileRead, GemID, IOTArrayBuilder, IOTArraySplitter, IPAddressServer, LocalMessageReference, LongToDate, MasterBooleanCalculator, MasterCalculator, MasterComparer, MasterMathConversions, Monitor, PassOnThread, PidControl, PLCArray, PLCServer, PropertyFilter, PublishBean, PWMManipulator, RaspiI2CManipulator, RaspiPinManipulator, RaspiPwmManipulator, RaspiSPIManipulator, RateCalculator, RegularExpression, Scaler, SerialPortManipulator, SetValue, SoundClipPlayer, SPC, SQLSelectStatement, StringBuilder, StringLength, StringSplitter, StringToArray, StringTrimmer, TimeDelayTrigger, TokenReplace, TrueFalseManipulator, URLReader, UserFileReader

public abstract class SimpleManipulator
extends Manipulator

This is the superclass of most manipulators that pass data through themselves, including Triggered manipulators. Connectors made to this server will, by default, send all values (not only changed values). The default auto suspend condition is autosuspend on no listeners. The beans will NOT send colors by default. Connectors into these objects will pass any quality values into the main connection, but will require good quality into any secondary (eg trigger) connections.

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

Constructor Summary

Constructors

Constructor and Description
SimpleManipulator() Generic constructor.

Method Summary

Modifier and Type	Method and Description
int	getDefaultQualityForLocation(int location) For any location returns QUALITY_GOOD for any secondary inputs, eg triggers meaning that values must be good to pass.

Methods inherited from class com.ergotech.vib.manipulators.Manipulator

getInPortNames, getStaticLocationFor, setBooleanValue, setBoolValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, toString, valueChanged, 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, getName, getOutPortNames, getPullFromServers, getPushData, getPushName, getPushToServers, getServerListData, getTimebase, getTrace, isActive, isScreenLocal, refreshCurrentValue, 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

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

Constructor Detail

SimpleManipulator

public SimpleManipulator()

Generic constructor.

Method Detail

getDefaultQualityForLocation

public int getDefaultQualityForLocation(int location)
                                 throws BadParameterException

For any location returns QUALITY_GOOD for any secondary inputs, eg triggers meaning that values must be good to pass. The main input will, by default, accept any quality of value. This default is usually correct, for example, if a server is hooked through this manipulator to a display, you want to pass BAD_QUALITY data to ensure that the display is updated to indicate and error on the server. Normally, you do not want to trigger a server with a bad quality value.

Overrides:

getDefaultQualityForLocation in class Manipulator

Parameters:

location - the method index.

Throws:

BadParameterException - never thrown.