com.ergotech.secs.gem

Class GemECID

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

com.ergotech.secs.gem.GemECID

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

GemLinkTestInterval, GemTimeFormat

public class GemECID
extends GemVID

storage for a ECID.

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
GemECID() Create and add a default validator.

Method Summary

Modifier and Type	Method and Description
void	addConnectionToDevice(java.lang.String newDeviceName, java.lang.String newDeviceTagNameOrRegister, java.lang.String inPort) Adds the connection from this server to the device and server.
ECIDValidationInterface	getValidator() Returns the validator.
void	removeConnectionToDevice(java.lang.String oldDeviceName, java.lang.String oldDeviceTagNameOrRegister, java.lang.String inPort) Removes the connection from this server to the device and server.
void	setDefaultValue(SecsFormat newValue) Create and add a validator for this element.
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	setValidator(ECIDValidationInterface validator) Sets the validator.
void	setValueObject(ValueObjectInterface newValue) Override the superclass to post the changed event.
void	validate(SecsFormat newValue) Validate the potential change.

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

checkLimits, convert, getCEID, getDeadband, getDefaultValue, getDefinedLimits, getLimitAsSF, getLimitMax, getLimitMaxAsSF, getLimitMin, getLimitMinAsSF, getSecsFormat, getSVName, getUnits, setCEID, setDeadband, setSVName, setUnits

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

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

GemECID

public GemECID()

Create and add a default validator. If another validator is added later this will be discarded, otherwise, if the limits are set it will throw if a value is outside of limitmin/max

Method Detail

addConnectionToDevice

public void addConnectionToDevice(java.lang.String newDeviceName,
                                  java.lang.String newDeviceTagNameOrRegister,
                                  java.lang.String inPort)
                           throws BadParameterException

Adds the connection from this server to the device and server. This is an ECID then we also need to make the connection from the server to this GemID

Overrides:

addConnectionToDevice in class GemID

Parameters:

newDeviceName - the device name of the source device - the device that contains the server

newDeviceTagNameOrRegister - the register or other tag identifier identifing the server in the particular device

inPort - the target inport

Throws:

BadParameterException - thrown if the server cannot be removed.

getValidator

public ECIDValidationInterface getValidator()

Returns the validator.

removeConnectionToDevice

public void removeConnectionToDevice(java.lang.String oldDeviceName,
                                     java.lang.String oldDeviceTagNameOrRegister,
                                     java.lang.String inPort)
                              throws BadParameterException

Removes the connection from this server to the device and server.

Overrides:

removeConnectionToDevice in class GemID

Throws:

BadParameterException - thrown if the server cannot be removed.

setDefaultValue

public void setDefaultValue(SecsFormat newValue)
                     throws VIBUpdateFailedException

Create and add a validator for this element. This will prevent values that are larger than limit /** Set the default value. This the value that is first set. For ECIDs ALL values have quality initial.

Overrides:

setDefaultValue in class GemVID

Throws:

VIBUpdateFailedException

setLimitMax

public void setLimitMax(double newValue)

Returns the Maximum acceptable value for a limit.

Overrides:

setLimitMax in class GemVID

setLimitMin

public void setLimitMin(double newValue)

Sets the minimum acceptable value for a limit.

Overrides:

setLimitMin in class GemVID

setValidator

public void setValidator(ECIDValidationInterface validator)

Sets the validator.

setValueObject

public void setValueObject(ValueObjectInterface newValue)
                    throws VIBUpdateFailedException

Override the superclass to post the changed event.

Overrides:

setValueObject in class GemVID

Parameters:

newValue - the new ValueObject value for the server

Throws:

VIBUpdateFailedException

See Also:

ValueObject

validate

public void validate(SecsFormat newValue)
              throws InvalidECIDChangeException

Validate the potential change.

Parameters:

newValue - the value that it is proposed to change to

Throws:

InvalidECIDChangeException - if the underlying validator throws an exception.