com.ergotech.secs.gem

Class ECHandler

java.lang.Object

com.ergotech.secs.gem.GemHandler

com.ergotech.secs.gem.ECHandler

All Implemented Interfaces:

AlarmWriter, EquipmentControlInterface, GemEquipmentInterface, ReportWriter, SecsEventListener, java.io.Serializable, java.util.EventListener

public class ECHandler
extends GemHandler
implements EquipmentControlInterface, java.io.Serializable

This is an implementation of the EquipmentControl. This is a GemEquipment that isn't gem compatable (since it adds methods that are suppost to only be set by the host)

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ergotech.secs.gem.GemHandler

alids, ceids, dataid, debugLevel, dvids, ecids, MDLN, monitors, nanoClock, onlineHandler, rptids, SOFTREV, svids

Fields inherited from interface com.ergotech.secs.gem.GemEquipmentInterface

ADJUSTED_TIME_CHANGED, ALARM_CLEARED, ALARM_DISABLED, ALARM_ENABLED, ALARM_REGISTERED, ALARM_SET, ALID, ALID_STR, ALL_ALARMS_DISABLED, ALL_ALARMS_ENABLED, ALL_EVENTS_DISABLED, ALL_EVENTS_ENABLED, ALL_LIMITS_UNREGISTERED, ALL_REPORTS_UNLINKED, ALL_REPORTS_UNREGISTERED, CEID, CEID_STR, DVID, DVVAL_CHANGED, ECID, ECID_CHANGED, EVENT_DISABLED, EVENT_ENABLED, EVENT_REGISTERED, EVENT_TRIGGERED, LIMIT_REGISTERED, LIMIT_TRIGGERED, LIMIT_UNREGISTERED, LIMITID, MONITOR_CHANGED, MONITOR_REGISTERED, MONITOR_TRIGGERED, REPORT_LINKED, REPORT_REGISTERED, REPORT_SENT, REPORT_UNLINKED, REPORT_UNREGISTERED, RPTID, SPOOL_ALL_STREAMS_REMOVED, SPOOL_STREAM_ADDED, SPOOL_STREAM_AND_FUNCTION_ADDED, SVID, SVID_CHANGED, TRID, VID, VID_CHANGED, VID_REGISTERED, VID_STR

Fields inherited from interface com.ergotech.secs.gem.ReportWriter

TRANSSECSCONTROLLER_NAME_KEY

Fields inherited from interface com.ergotech.secs.gem.AlarmWriter

cvsRev

Fields inherited from interface com.ergotech.secs.SecsEventListener

cvsRev

Method Summary

Modifier and Type	Method and Description
void	defineReport(SecsFormat3x5x rptid, java.util.List<java.lang.Long> report) Define a report.
void	defineVariableLimits(SecsFormat3x5x vid, SecsFormat3x5x limitID, double lowerDB, double upperDB) Define variable limits.
void	enableAlarm(SecsFormat3x5x alid, boolean enable) Register default parameters for limits monitoring for a particular VID.
void	enableReport(SecsFormat3x5x ceid, boolean flag) Enable or disable a event reporting.
void	linkReport(SecsFormat3x5x rptid, SecsFormat3x5x ceid, boolean link) Link a report to a CEID.
void	registerLimitDefaults(SecsFormat3x5x vid, SecsFormat3x5x ceid, java.lang.String vidName) Register a limit ceid for a specific VID.
void	undefineVariableLimits(SecsFormat3x5x vid, SecsFormat3x5x limitID) This will undefine the limit for the vid.

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

addMessageHandler, clearAlarm, clearAlarm, clearAlarm, convertDate, convertInstant, destroy, findLimit, generateAlarm, generateReport, generateReport, generateReport, getAdjustedDate, getAdjustedInstant, getAlarm, getAlarmsSet, getAllALIDs, getAllCEIDs, getAllDVIDs, getAllECIDs, getAllRPTID, getAllSVIDs, getData, getDateOffset, getDvname, getDVNAME, getEquipmentName, getGemContainer, getKey, getLimitName, getName, getName, getOnlineHandler, getOnlineMode, getReportValues, getSecsFormat, getSecsFormat, getServerFor, getServerForName, getType, getValue, getValue, getValue, isS1F3ReturnsValues, populateDVIDs, registerAlarm, registerALID, registerALID, registerCEID, registerCEID, registerCEIDIfNotExist, registerECIDValidator, registerECIDValidator, registerForUpdate, registerForUpdate, registerTrace, registerVID, registerVID, registerVIDMonitor, removeByName, requestOnline, S1F1, S1F11, S1F13, S1F21, S1F23, S1F3, S2F13, S2F15, S2F17, S2F23, S2F25, S2F29, S2F31, S2F33, S2F35, S2F37, S2F39, S2F45, S2F47, S5F3, S5F5, S5F7, S6F15, S6F17, S6F19, S6F21, S6F5, saveModel, secsEvent, sendEventReport, sendEventReport, sendEventReport, sendS9F7, setAlarm, setAlarm, setAlarm, setAllLimitToUndefined, setAllLimitToUndefined, setDateOffset, setEquipmentName, setLimitToUndefined, setLocal, setOnlineHandler, setS1F3ReturnsValues, setValue, setValue, setValue, setValue, stripType

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ergotech.secs.gem.EquipmentControlInterface

destroy

Methods inherited from interface com.ergotech.secs.gem.GemEquipmentInterface

addMessageHandler, clearAlarm, clearAlarm, getOnlineMode, getValue, registerALID, registerCEID, registerECIDValidator, registerForUpdate, registerVID, registerVID, registerVIDMonitor, requestOnline, sendEventReport, setAlarm, setAlarm, setEquipmentName, setLocal, setValue

Method Detail

defineReport

public void defineReport(SecsFormat3x5x rptid,
                         java.util.List<java.lang.Long> report)
                  throws SecsException

Define a report. This simulates the functionality of an S2F33 message. The report should be a vector of strings. Each string should be the vid, svid, ecid, or dvname of the value expected.

Specified by:

defineReport in interface EquipmentControlInterface

Parameters:

rptid - the report that is being registered

report - a vector of Integers representing IDs. If the value is not an Integer an attempt will be made to convert the sting value (toString) of the provided object to an Integer. If that fails, then the error will be logged and the value ignored.

Throws:

SecsException - if the report is badly formatted, or if one of the id's is not registered.

defineVariableLimits

public void defineVariableLimits(SecsFormat3x5x vid,
                                 SecsFormat3x5x limitID,
                                 double lowerDB,
                                 double upperDB)
                          throws SecsException

Define variable limits. This simulates an S2F45 message.

Specified by:

defineVariableLimits in interface EquipmentControlInterface

Parameters:

vid - the vid

limitID - the limit id

lowerDB - the lower deadband

upperDB - the upper deadband

Throws:

SecsException

enableAlarm

public void enableAlarm(SecsFormat3x5x alid,
                        boolean enable)
                 throws SecsException

Register default parameters for limits monitoring for a particular VID. /** This method allows the equipment to control enabling and disabling alarms. It is not an error to enable an enabled alarm or disable a disabled alarm.

Specified by:

enableAlarm in interface EquipmentControlInterface

Parameters:

alid - the alarm id to enable or disable

enable - if true will enable the alarm, otherwise disable.

Throws:

SecsException

enableReport

public void enableReport(SecsFormat3x5x ceid,
                         boolean flag)
                  throws SecsException

Enable or disable a event reporting. This simulates an S2F37 message.

Specified by:

enableReport in interface EquipmentControlInterface

Parameters:

ceid - the event to enable

flag - true to enable the report, false to disable the report

Throws:

SecsException - if the ceid does not exist.

linkReport

public void linkReport(SecsFormat3x5x rptid,
                       SecsFormat3x5x ceid,
                       boolean link)
                throws SecsException

Link a report to a CEID. This simulates an S2F35 message.

Specified by:

linkReport in interface EquipmentControlInterface

Parameters:

report - the report that is being linked

ceid - the ceid to which the report is to be linked.

link - true to link the report, false to unlink the report

Throws:

SecsException - if either the rptid or ceid do not exist.

registerLimitDefaults

public void registerLimitDefaults(SecsFormat3x5x vid,
                                  SecsFormat3x5x ceid,
                                  java.lang.String vidName)

Register a limit ceid for a specific VID. This will do nothing unless the limit is configured by the S2F45 message.

Specified by:

registerLimitDefaults in interface EquipmentControlInterface

Parameters:

vid - the vid that this limit is being registered for

ceid - the limit ceid that is being registered.

undefineVariableLimits

public void undefineVariableLimits(SecsFormat3x5x vid,
                                   SecsFormat3x5x limitID)
                            throws SecsException

This will undefine the limit for the vid.

Specified by:

undefineVariableLimits in interface EquipmentControlInterface

Parameters:

vid - the vid

limitID - the limit id

Throws:

SecsException