com.ergotech.secs.gem

Class GemID

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

GemALID, GemCEID, GemHostCEID, GemLIMITID, GemRPTID, GemVID

public abstract class GemID
extends SimpleManipulator
implements java.io.Serializable

This will store any of the ID's.

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
GemID() The default constructor.

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.
SecsFormat3x5x	getID() Returns the id of the object.
java.lang.String	getName() Returns the name of the object.
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	setID(SecsFormat3x5x newValue) Set the id of the object.
void	setName(java.lang.String newValue) Set the name of the object.
void	setProperty(java.lang.String name, SecsFormat value, ValueObjectInterface valueObject) Find the DVNAME of the name and set the name and the value as a property to the provided value object.
void	valueInput(ValueChangedEvent newEvent) overrides Manipulator valueInput so we can only use good quality data.

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

Constructor Detail

GemID

public GemID()

The default constructor.

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.

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.

getID

public SecsFormat3x5x getID()

Returns the id of the object.

getName

public java.lang.String getName()

Returns the name of the object.

Overrides:

getName in class SimpleDataSource

Returns:

Returns the data source name.

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.

Throws:

BadParameterException - thrown if the server cannot be removed.

setID

public void setID(SecsFormat3x5x newValue)

Set the id of the object.

setName

public void setName(java.lang.String newValue)

Set the name of the object.

Overrides:

setName in class SimpleDataSource

See Also:

#getTagName

setProperty

public void setProperty(java.lang.String name,
                        SecsFormat value,
                        ValueObjectInterface valueObject)

Find the DVNAME of the name and set the name and the value as a property to the provided value object. The value will be ignored if the DVNAME is not registered.

valueInput

public void valueInput(ValueChangedEvent newEvent)
                throws VIBUpdateFailedException

overrides Manipulator valueInput so we can only use good quality data. this is needed so that managed connections from data sources do not keep changing the internal VID value when the data source is flakey (and triggering alarms).

Overrides:

valueInput in class Manipulator

Parameters:

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

Throws:

VIBUpdateFailedException