com.ergotech.secs.gem

Class GemALID

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

All Implemented Interfaces:

java.io.Serializable

public class GemALID
extends GemID

This holds all information about a single alarm.

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 java.lang.String	ALCD_PORT_NAME This is the name that we publish use to publish the trigger.
static int	antiReboundDeadband The anti-rebound timeout.
static boolean	dontSendClear Customer request to send only set notification not cleared.
static java.lang.String	ENABLED_PORT_NAME This is the name that we publish use to publish the enabled flag.
static boolean	legacyAlarms For legacy reasons, if this flag is true, we will allow alarms to be set or cleared multiple times.
static java.lang.String	TRIGGER_PORT_NAME This is the name that we publish use to publish the trigger.

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
GemALID()

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the alarm and triggers the event if enabled.
void	clear(ValueObjectInterface value) Clears the alarm and triggers the event if enabled.
AlarmWriter	getAlarmWriter()
byte	getALCD() Returns the alarm code.
boolean	getALED() Returns the alarm enabled flag.
java.lang.String	getALTX() Returns the alarm text.
GemCEID	getClearCEID() Returns the CEID to send when the alarm is cleared.
boolean	getEnabled() This is just a pass through to setALED, but the name is more user friendly.
GemCEID	getSetCEID() Returns the CEID to send when the alarm is set.
boolean	isSet() Returns the status of the alarm.
void	set() Sets the alarm and triggers the event if enabled.
void	set(ValueObjectInterface value) Sets the alarm and triggers the event if enabled.
void	setAlarmWriter(AlarmWriter alarmWriter)
void	setALCD(byte newValue) Sets the alarm code flag.
void	setALED(boolean aled) Sets the alarm enabled flag.
void	setALTX(java.lang.String newValue) Set the alarm text.
void	setClearCEID(GemCEID newValue) Sets the alarm to set when the alarm is cleared.
void	setEnabled(boolean enabled) This is just a pass through to setALED, but the name is more user friendly.
void	setSetCEID(GemCEID newValue) Sets the CEID to send when the alarm is set.
void	setValueObject(ValueObjectInterface newValue) Set the value to the new value.
void	trigger(ValueChangedEvent event) Set the value to the new value if data quality is good.

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

Field Detail

ALCD_PORT_NAME

public static final java.lang.String ALCD_PORT_NAME

This is the name that we publish use to publish the trigger.

See Also:

Constant Field Values

antiReboundDeadband

public static int antiReboundDeadband

The anti-rebound timeout. Set to non-zero to enable antirebound

dontSendClear

public static boolean dontSendClear

Customer request to send only set notification not cleared.

ENABLED_PORT_NAME

public static final java.lang.String ENABLED_PORT_NAME

This is the name that we publish use to publish the enabled flag.

See Also:

Constant Field Values

legacyAlarms

public static boolean legacyAlarms

For legacy reasons, if this flag is true, we will allow alarms to be set or cleared multiple times. If false, the alarm will not be set/cleared if it is already in that state but the associated event, if configured, will be sent.

TRIGGER_PORT_NAME

public static final java.lang.String TRIGGER_PORT_NAME

This is the name that we publish use to publish the trigger.

See Also:

Constant Field Values

Constructor Detail

GemALID

public GemALID()

Method Detail

clear

public void clear()
           throws SecsException

Clears the alarm and triggers the event if enabled.

Throws:

SecsException - thrown if the alarm message, or the event message cannot be sent because there is no connection. Note that this will NOT be thrown if spooling is enabled even if there is no connection to the host.

clear

public void clear(ValueObjectInterface value)
           throws SecsException

Clears the alarm and triggers the event if enabled.

Parameters:

value - the value used to trigger the ceid, usually only the properties are of interest.

Throws:

SecsException - thrown if the alarm message, or the event message cannot be sent because there is no connection. Note that this will NOT be thrown if spooling is enabled even if there is no connection to the host.

SecsException

getAlarmWriter

public AlarmWriter getAlarmWriter()

getALCD

public byte getALCD()

Returns the alarm code. See the E5 spec. for details.

getALED

public boolean getALED()

Returns the alarm enabled flag.

getALTX

public java.lang.String getALTX()

Returns the alarm text.

getClearCEID

public GemCEID getClearCEID()

Returns the CEID to send when the alarm is cleared.

getEnabled

public boolean getEnabled()

This is just a pass through to setALED, but the name is more user friendly.

Returns:

the Enabled Status

getSetCEID

public GemCEID getSetCEID()

Returns the CEID to send when the alarm is set.

isSet

public boolean isSet()

Returns the status of the alarm.

set

public void set()
         throws SecsException

Sets the alarm and triggers the event if enabled.

Throws:

SecsException - thrown if the alarm message, or the event message cannot be sent because there is no connection. Note that this will NOT be thrown if spooling is enabled even if there is no connection to the host.

set

public void set(ValueObjectInterface value)
         throws SecsException

Sets the alarm and triggers the event if enabled.

Parameters:

value - the value used to trigger the ceid, usually only the properties are of interest.

Throws:

SecsException - thrown if the alarm message, or the event message cannot be sent because there is no connection. Note that this will NOT be thrown if spooling is enabled even if there is no connection to the host.

SecsException

setAlarmWriter

public void setAlarmWriter(AlarmWriter alarmWriter)

setALCD

public void setALCD(byte newValue)

Sets the alarm code flag. This indicates the severity of the alarm as per the E5 spec.

setALED

public void setALED(boolean aled)

Sets the alarm enabled flag.

Parameters:

aled - true to enable the alarm, false to disable.

setALTX

public void setALTX(java.lang.String newValue)

Set the alarm text.

setClearCEID

public void setClearCEID(GemCEID newValue)

Sets the alarm to set when the alarm is cleared.

setEnabled

public void setEnabled(boolean enabled)

This is just a pass through to setALED, but the name is more user friendly.

setSetCEID

public void setSetCEID(GemCEID newValue)

Sets the CEID to send when the alarm is set.

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

trigger

public void trigger(ValueChangedEvent event)
             throws VIBUpdateFailedException

Set the value to the new value if data quality is good. 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.

Throws:

VIBUpdateFailedException