com.ergotech.secs.gem

Class GemCEID

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

All Implemented Interfaces:

GemCEIDExportInterface, java.io.Serializable

public class GemCEID
extends GemID
implements GemCEIDExportInterface

This server maintains the information associated with a CEID. This includes which reports are linked to the CEID and whether the CEID is enabled. The reports are stored in terms of a Vector of GemRPTID objects.

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 boolean	edgeTrigger If true, the CEIDs will trigger only on the rising edge (0->1) or more techically false(0) to true (non-zero).
static java.lang.String	ENABLED_PORT_NAME This is the name that we publish use to publish the enabled flag.
static java.lang.String	FAILED_TRIGGER_CONDITIONS Will be true if the event was not triggered because it failed a trigger condition - typically edge triggering.
static java.lang.String	SOURCEVID
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
GemCEID() Default Constructor.

Method Summary

Modifier and Type	Method and Description
void	clearAllReports() Clears all reports associated with this CEID.
void	clearReport(GemRPTID reportID) Clears a particular report associated with this CEID.
java.util.Vector<GemRPTID>	getAllReports() Returns a vector of all the reports that are linked to this CEID.
java.util.List<SecsFormat>	getDVIDs() Returns the collection of dvids associated with this CEID.
boolean	getEnabled() Returns true if the CEID is enabled.
SecsFormat	getLastMessageSent() Returns the last event message that was sent with this CEID.
int	getStaticLocationFor(java.lang.String method) Add the "Trigger" input.
boolean	isLinked() Returns true if any reports are linked to this CEID.
void	linkReport(GemRPTID reportID) Links the report to this CEID if it is not already linked.
void	setDVIDs(java.util.List<SecsFormat> dvids) Sets the collection of dvids associated with this CEID.
void	setEnabled(boolean newValue) Enables or disables the CEID.
void	setEnabled(boolean newValue, boolean post) Enables or disables the CEID.
void	setLastMessageSent(SecsFormat newValue) Sets the last event message that was sent with this CEID.
void	setReportWriter(ReportWriter newValue) Sets the component that will act as a report writer for this component.
void	setValueObject(ValueObjectInterface newValue) Received as a result of a value changed.
SecsFormat	setValueObject(ValueObjectInterface newValue, boolean saveData) Received as a result of a value changed.
SecsFormat	setValueObjectSaveData(ValueObjectInterface newValue) Received as a result of a value changed.
void	trigger(ValueObjectInterface newValue) This will send the event report if the report is enabled and the trigger data quality is good.
void	valueChanged(int loc, ValueChangedEvent e) Add the "Trigger" input.
void	valueInput(ValueChangedEvent newEvent) Reset the trigger if the flag is set.

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

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

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

getDefaultQualityForLocation

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

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

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

edgeTrigger

public static boolean edgeTrigger

If true, the CEIDs will trigger only on the rising edge (0->1) or more techically false(0) to true (non-zero). This is added to, for example, prevent triggering when the register in a PLC is reset.

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

FAILED_TRIGGER_CONDITIONS

public static final java.lang.String FAILED_TRIGGER_CONDITIONS

Will be true if the event was not triggered because it failed a trigger condition - typically edge triggering.

See Also:

Constant Field Values

SOURCEVID

public static final java.lang.String SOURCEVID

See Also:

Constant Field Values

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

GemCEID

public GemCEID()

Default Constructor.

Method Detail

clearAllReports

public void clearAllReports()

Clears all reports associated with this CEID.

clearReport

public void clearReport(GemRPTID reportID)

Clears a particular report associated with this CEID.

getAllReports

public java.util.Vector<GemRPTID> getAllReports()

Returns a vector of all the reports that are linked to this CEID.

getDVIDs

public java.util.List<SecsFormat> getDVIDs()

Returns the collection of dvids associated with this CEID. The return may be null.

getEnabled

public boolean getEnabled()

Returns true if the CEID is enabled.

getLastMessageSent

public SecsFormat getLastMessageSent()

Returns the last event message that was sent with this CEID.

getStaticLocationFor

public int getStaticLocationFor(java.lang.String method)
                         throws BadParameterException

Add the "Trigger" input.

Overrides:

getStaticLocationFor in class Manipulator

Throws:

BadParameterException

See Also:

Manipulator.getStaticLocationFor(java.lang.String)

isLinked

public boolean isLinked()

Returns true if any reports are linked to this CEID.

linkReport

public void linkReport(GemRPTID reportID)

Links the report to this CEID if it is not already linked.

setDVIDs

public void setDVIDs(java.util.List<SecsFormat> dvids)

Sets the collection of dvids associated with this CEID.

setEnabled

public void setEnabled(boolean newValue)

Enables or disables the CEID. The report is enabled if the newValue is true.

Parameters:

newValue - enables the report if true, disables the report if false.

setEnabled

public void setEnabled(boolean newValue,
                       boolean post)

Enables or disables the CEID. The resport is enabled if the newValue is true.

Parameters:

newValue - enables the report if true, disables the report if false.

post - will post SECSEvents if true

setLastMessageSent

public void setLastMessageSent(SecsFormat newValue)

Sets the last event message that was sent with this CEID. newValue is a SecsFormat00 representing the whole message.

setReportWriter

public void setReportWriter(ReportWriter newValue)

Sets the component that will act as a report writer for this component. This is usually the GEM handler.

setValueObject

public void setValueObject(ValueObjectInterface newValue)
                    throws VIBUpdateFailedException

Received as a result of a value changed. This will call "trigger" to potentially send an event report.

Overrides:

setValueObject in class SimpleDataSource

Parameters:

newValue - the new ValueObject value for the server

Throws:

VIBUpdateFailedException

See Also:

ValueObject

setValueObject

public SecsFormat setValueObject(ValueObjectInterface newValue,
                                 boolean saveData)
                          throws VIBUpdateFailedException

Received as a result of a value changed. This will call "trigger" to potentially send an event report.

Throws:

VIBUpdateFailedException

setValueObjectSaveData

public SecsFormat setValueObjectSaveData(ValueObjectInterface newValue)
                                  throws VIBUpdateFailedException

Received as a result of a value changed. This will call "trigger" to potentially send an event report.

Throws:

VIBUpdateFailedException

trigger

public void trigger(ValueObjectInterface newValue)
             throws SecsException

This will send the event report if the report is enabled and the trigger data quality is good.

Specified by:

trigger in interface GemCEIDExportInterface

Throws:

SecsException - thrown if the event is not 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.

valueChanged

public void valueChanged(int loc,
                         ValueChangedEvent e)
                  throws VIBUpdateFailedException,
                         BadParameterException

Add the "Trigger" input.

Overrides:

valueChanged in class Manipulator

Throws:

VIBUpdateFailedException

BadParameterException

See Also:

Manipulator.valueChanged(int, com.ergotech.vib.valueobjects.ValueChangedEvent)

valueInput

public void valueInput(ValueChangedEvent newEvent)
                throws VIBUpdateFailedException

Reset the trigger if the flag is set.

Overrides:

valueInput in class GemID

Parameters:

newEvent - the source of the event must be the Manipulator for which the value will be reset.

Throws:

VIBUpdateFailedException