com.ergotech.secs.gem

Interface EquipmentControlInterface

All Superinterfaces:

GemEquipmentInterface

All Known Implementing Classes:

ECHandler

public interface EquipmentControlInterface
extends GemEquipmentInterface

This allows control over the configuration of the equipment that by the gem standards would normally be set by the host.

Field Summary

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

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	destroy() Clear all the variable and any persistent states.
void	enableAlarm(SecsFormat3x5x alid, boolean enable) This method allows the equipment to control enabling and disabling alarms.
void	enableReport(SecsFormat3x5x ceid, boolean flag) Enable or disable a event reporting.
void	linkReport(SecsFormat3x5x rptid, SecsFormat3x5x ceid, boolean flag) Link a report to a CEID.
void	registerLimitDefaults(SecsFormat3x5x vid, SecsFormat3x5x ceid, java.lang.String vidName) Register default parameters for limits monitoring for a particular VID.
void	undefineVariableLimits(SecsFormat3x5x vid, SecsFormat3x5x limitID) This will undefine the limit for the vid.

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

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.

Parameters:

rptid - the report that is being registered

report - a vector of strings representing IDs

Throws:

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

defineVariableLimits

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

Define variable limits. This simulates an S2F45 message.

Throws:

SecsException

destroy

void destroy()

Clear all the variable and any persistent states.

enableAlarm

void enableAlarm(SecsFormat3x5x alid,
                 boolean enable)
          throws SecsException

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.

Parameters:

alid - the alarm id to enable or disable

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

Throws:

SecsException

enableReport

void enableReport(SecsFormat3x5x ceid,
                  boolean flag)
           throws SecsException

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

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

void linkReport(SecsFormat3x5x rptid,
                SecsFormat3x5x ceid,
                boolean flag)
         throws SecsException

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

Parameters:

report - the report that is being linked

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

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

Throws:

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

registerLimitDefaults

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

Register default parameters for limits monitoring for a particular VID. This allows a default to be set that will be used for any monitored LimitID that does not otherwise have values set. GEM requires a minimum of seven limits if no limits, or less than seven limits are registered then teh default values will be used to set the missing limits.

undefineVariableLimits

void undefineVariableLimits(SecsFormat3x5x vid,
                            SecsFormat3x5x limitID)
                     throws SecsException

This will undefine the limit for the vid.

Parameters:

vid - the vid

limitID - the limit id

Throws:

SecsException