com.ergotech.secs.gem

Class GemLIMITID

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.secs.gem.GemID

com.ergotech.secs.gem.GemLIMITID

All Implemented Interfaces:

java.io.Serializable

public class GemLIMITID
extends GemID

This manipulator will keep track of the state of the limitid. When the state changes, it will send a valuechanged 'pulse' with the LimitVariable, EventLimit, TransitionType, and the Limit as properties (assumed to be connected to a GemCEID server that will in turn create a report based on the information.

See Also:

Serialized Form

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 int	LOWERZONE
static int	UNDEFINED
static int	UPPERZONE

Fields inherited from class com.ergotech.vib.manipulators.SimpleManipulator

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

Constructor Summary

Constructors

Constructor and Description
GemLIMITID() Default constructor.

Method Summary

Modifier and Type	Method and Description
LIMITID	getLimitId() Returns the limit id.
double	getLowerDB() Returns the lower DB.
double	getUpperDB() Returns the upper DB.
GemVID	getVID() Returns the VID that this limit is associated with.
void	removeLimit() Remove this limit.
void	setLimitId(LIMITID limitId) Sets the limit id.
void	setLowerDB(double newValue) Sets the lower DB.
void	setState(int newState) Sets the current state of the limit.
void	setUpperDB(double newValue) Sets the upper DB.
void	setValueObject(ValueObjectInterface newValue) Checks the value of the incoming object against the limits.
void	setVID(GemVID newValue) Sets the VID that this limit is associated with.
void	VIBEvent(VIBEvent event) Implement of VIBEventListener.

Methods inherited from class com.ergotech.secs.gem.GemID

addConnectionToDevice, getID, getName, removeConnectionToDevice, setID, setName, setProperty, valueInput

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

getDefaultQualityForLocation

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

getInPortNames, getStaticLocationFor, setBooleanValue, setBoolValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, toString, valueChanged

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, getOutPortNames, getPullFromServers, getPushData, getPushName, getPushToServers, getServerListData, getTimebase, getTrace, isActive, isScreenLocal, refreshCurrentValue, removeConnector, removeDataSource, removePropertyChangeListener, removeValueChangedListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setContainer, setCustomTimer, setDataSourceName, setExportCriteria, setExposeComponentConnections, setPullFromServers, setPushData, setPushName, setPushToServers, setScreenLocal, setServerListData, setTimebase, setTrace, start, stop, tick

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

LOWERZONE

public static final int LOWERZONE

See Also:

Constant Field Values

UNDEFINED

public static final int UNDEFINED

See Also:

Constant Field Values

UPPERZONE

public static final int UPPERZONE

See Also:

Constant Field Values

Constructor Detail

GemLIMITID

public GemLIMITID()

Default constructor.

Method Detail

getLimitId

public LIMITID getLimitId()

Returns the limit id.

getLowerDB

public double getLowerDB()

Returns the lower DB.

getUpperDB

public double getUpperDB()

Returns the upper DB.

getVID

public GemVID getVID()

Returns the VID that this limit is associated with. The returned object (GemVID) can be queried for the SecsFormat version of the VID via the "getID" method.

See Also:

GemVID

removeLimit

public void removeLimit()

Remove this limit.

setLimitId

public void setLimitId(LIMITID limitId)

Sets the limit id.

setLowerDB

public void setLowerDB(double newValue)

Sets the lower DB.

setState

public void setState(int newState)

Sets the current state of the limit. This will be either UNDEFINED (the initial condition), LOWERZONE or UPPERZONE.

setUpperDB

public void setUpperDB(double newValue)

Sets the upper DB.

setValueObject

public void setValueObject(ValueObjectInterface newValue)
                    throws VIBUpdateFailedException

Checks the value of the incoming object against the limits. This will cause the CEID event to be fired if it is registered.

Overrides:

setValueObject in class SimpleDataSource

Parameters:

newValue - the new ValueObject value for the server

Throws:

VIBUpdateFailedException - thrown if the sending of the value fails

See Also:

ValueObject

setVID

public void setVID(GemVID newValue)

Sets the VID that this limit is associated with.

VIBEvent

public void VIBEvent(VIBEvent event)
              throws BadParameterException

Implement of VIBEventListener. This waits for the "CLIENT_ATTACHED" and "CLIENT_REMOVED" events. These are used to set the VID.

Overrides:

VIBEvent in class SimpleDataSource

Throws:

BadParameterException