com.ergotech.secs.gem

Class SendEvent

java.lang.Object

com.ergotech.secs.gem.SendEvent

Direct Known Subclasses:

CommunicationsHandler, OnlineHandler

public abstract class SendEvent
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	equipmentName The equipment name of the GEM interface associated with this instance.

Constructor Summary

Constructors

Constructor and Description
SendEvent()

Method Summary

Modifier and Type	Method and Description
SecsFormat20	addClockAsDVVAL() Add the current adjusted GEM time as a DDVAL in the transitionSpecificDvvals and return the value
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,SecsFormat>	getAllExtendedAttributes() Return the (mutable) map of extended attributes.
SecsFormat	getExtendedAttribute(java.lang.String attribute) Return the value for an extended attribute or null if the attribute does not exist.
int	hashCode()
void	sendEvent(java.lang.String ceidName) This method sends the S6F11 event for the given ID.
void	setAlarm(java.lang.String alidName, java.util.Map<java.lang.String,java.lang.Integer> alarmMapping) This method sends an S5F1 for given ID.
SecsFormat	setExtendedAttribute(java.lang.String attribute, SecsFormat value) Set an extended attribute and return the existing (may be null).

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

equipmentName

public java.lang.String equipmentName

The equipment name of the GEM interface associated with this instance.

Constructor Detail

SendEvent

public SendEvent()

Method Detail

addClockAsDVVAL

public SecsFormat20 addClockAsDVVAL()

Add the current adjusted GEM time as a DDVAL in the transitionSpecificDvvals and return the value

Returns:

the current adjusted GEM time

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getAllExtendedAttributes

public java.util.Map<java.lang.String,SecsFormat> getAllExtendedAttributes()

Return the (mutable) map of extended attributes. If the extended attributes map does not exist it will be created and returned (empty).

Returns:

a non-null, but possibly empty, map.

getExtendedAttribute

public SecsFormat getExtendedAttribute(java.lang.String attribute)

Return the value for an extended attribute or null if the attribute does not exist.

Parameters:

attribute - the name of the attribute to read

Returns:

the existing value or null if the attribute is unknown.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

sendEvent

public void sendEvent(java.lang.String ceidName)

This method sends the S6F11 event for the given ID. It will search for the CEID for the give ID in the GEM model and then send the event. The CEIDs must have been registered in order for the event to be sent correctly. They are registered by name and the names must exactly match (including case) the names in the Semi spec.

Parameters:

ceidName - the id of the event to send. This is assumed to match a registered event that should have been registered with the gem handler.

setAlarm

public void setAlarm(java.lang.String alidName,
                     java.util.Map<java.lang.String,java.lang.Integer> alarmMapping)

This method sends an S5F1 for given ID. It looks up the ALID in the provided hashtable and logs an error or successful send.

Parameters:

alidName - the id of the event to send.

alarmMapping - a hashtable of alidName vs. Integer that provides the alid for the alarm to be sent

setExtendedAttribute

public SecsFormat setExtendedAttribute(java.lang.String attribute,
                                       SecsFormat value)

Set an extended attribute and return the existing (may be null). If the extended attribute does not exist it will be created. If the value is null the attribute will be deleted. This is called by the tool and is not an object service (E39)

Parameters:

attribute - the name of the attribute to set

value - the new value

Returns:

the existing value, if any