com.ergotech.secs.gem

Class GemVID

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.GemVID

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

GemECID, GemSVID

public class GemVID
extends GemID

This will store the current value of a VID.

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 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
GemVID() Create the GemVID.

Method Summary

Modifier and Type	Method and Description
boolean	checkLimits(SecsFormatValueObject incomingValue) Used in setValueObject replaces evaluation for comparing limits.
SecsFormatValueObject	convert(ValueObjectInterface value) Converts the value object to a SecsFormatValueObject.
GemCEID	getCEID() Returns the CEID associated with vid monitoring.
double	getDeadband() Returns the deadband.
SecsFormat	getDefaultValue() Returns the default value as a SecsFormat.
java.util.List<GemLIMITID>	getDefinedLimits() Returns all the limits that are registered for this variable in order.
SecsFormat	getLimitAsSF(double limitValue) Returns the upper limit as a SecsFormat.
double	getLimitMax() Returns the Maximum acceptable value for a limit.
SecsFormat	getLimitMaxAsSF() Returns the upper limit as a SecsFormat.
double	getLimitMin() Returns the minimum acceptable value for a limit.
SecsFormat	getLimitMinAsSF() Returns the lower limit as a SecsFormat.
SecsFormat	getSecsFormat() Returns the current value of this object as a SecsFormat.
java.lang.String	getSVName() This is used for S1F12 only.
java.lang.String	getUnits() Returns the name of the units.
void	setCEID(GemCEID newValue) Sets the CEID associated with vid monitoring.
void	setDeadband(double deadband) Saves the deadband.
void	setDefaultValue(SecsFormat newValue) Set the default value.
void	setLimitMax(double newValue) Returns the Maximum acceptable value for a limit.
void	setLimitMin(double newValue) Sets the minimum acceptable value for a limit.
void	setSVName(java.lang.String newValue) This is used for S1F12 only.
void	setUnits(java.lang.String newValue) Sets the name of the units.
void	setValueObject(ValueObjectInterface newValue) Set the value to the new value.

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, 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

Constructor Detail

GemVID

public GemVID()

Create the GemVID.

Method Detail

checkLimits

public boolean checkLimits(SecsFormatValueObject incomingValue)

Used in setValueObject replaces evaluation for comparing limits. Returns true if getLimitMin()

convert

public SecsFormatValueObject convert(ValueObjectInterface value)

Converts the value object to a SecsFormatValueObject. If the value is currently a SecsFormatValueObject then it is returned unchanged, otherwise, the value is wrapped in a SecsFormat object from which a SecsFormatValueObject is created.

Parameters:

value - the current value

getCEID

public GemCEID getCEID()

Returns the CEID associated with vid monitoring.

See Also:

GemEquipmentInterface.registerVIDMonitor(int, int, java.lang.String, com.ergotech.secs.SecsFormat)

getDeadband

public double getDeadband()

Returns the deadband.

getDefaultValue

public SecsFormat getDefaultValue()

Returns the default value as a SecsFormat.

getDefinedLimits

public java.util.List<GemLIMITID> getDefinedLimits()

Returns all the limits that are registered for this variable in order. Note: This method is not thread-safe. Limits should not be added or removed while this method is in process.

getLimitAsSF

public SecsFormat getLimitAsSF(double limitValue)

Returns the upper limit as a SecsFormat.

getLimitMax

public double getLimitMax()

Returns the Maximum acceptable value for a limit.

getLimitMaxAsSF

public SecsFormat getLimitMaxAsSF()

Returns the upper limit as a SecsFormat.

getLimitMin

public double getLimitMin()

Returns the minimum acceptable value for a limit.

getLimitMinAsSF

public SecsFormat getLimitMinAsSF()

Returns the lower limit as a SecsFormat.

getSecsFormat

public SecsFormat getSecsFormat()

Returns the current value of this object as a SecsFormat. The current value must be a SecsFormatValueObject.

Returns:

getSVName

public java.lang.String getSVName()

This is used for S1F12 only.

getUnits

public java.lang.String getUnits()

Returns the name of the units.

setCEID

public void setCEID(GemCEID newValue)

Sets the CEID associated with vid monitoring.

See Also:

GemEquipmentInterface.registerVIDMonitor(int, int, java.lang.String, com.ergotech.secs.SecsFormat)

setDeadband

public void setDeadband(double deadband)

Saves the deadband. This will be set to any connector that is attached to this server.

Parameters:

deadband -

setDefaultValue

public void setDefaultValue(SecsFormat newValue)
                     throws VIBUpdateFailedException

Set the default value. This the value that is first set.

Throws:

VIBUpdateFailedException

setLimitMax

public void setLimitMax(double newValue)

Returns the Maximum acceptable value for a limit.

setLimitMin

public void setLimitMin(double newValue)

Sets the minimum acceptable value for a limit.

setSVName

public void setSVName(java.lang.String newValue)

This is used for S1F12 only.

setUnits

public void setUnits(java.lang.String newValue)

Sets the name of the units.

setValueObject

public void setValueObject(ValueObjectInterface newValue)
                    throws VIBUpdateFailedException

Set the value to the new value. If the new value is not a SecsFormat value object it will be converted to an object of the type of the default value. If there is not value and the new value is not a SecsFormat then the value will be ignored.

Overrides:

setValueObject in class SimpleDataSource

Parameters:

newValue - the new ValueObject value for the server

Throws:

VIBUpdateFailedException

See Also:

ValueObject