com.ergotech.secs

Class S5F3

java.lang.Object

com.ergotech.secs.SecsTrigger

com.ergotech.secs.SecsMsg

com.ergotech.secs.S5F3

All Implemented Interfaces:

java.io.Serializable

public class S5F3
extends SecsMsg

Enable/Disable Alarm Send (EAS). This message will change the state of the enable bit in the equipment. The enable bit determines if the alarm will be sent to the host. Alarms which are not controllable in this way are unaffected by this message. The format of this message is a list (SecsFormat00) of ALED, ALID data structures.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	cvsRev

Fields inherited from class com.ergotech.secs.SecsMsg

allowBrokenMessages, allowGenericSecsMessage, ALWAYS, ALWAYS_244BLOCK, ALWAYS_SECS1, CANNOT_SEND, F0_ERROR, maxRetryAttempts, NO_ERROR, replyBit, responseError, S9_ERROR, SECS1_244BLOCK, SECS1_MULTIBLOCK, sendErrors, TIMEOUT_ERROR, UNSOLICITED

Constructor Summary

Constructors

Constructor and Description
S5F3() Required empty constructor.
S5F3(ALED s1, ALID s2) Creates this message from and ALED, ALID object.
S5F3(SecsFormat theData) The data is assumed to be correct format and is not checked.
S5F3(SecsFormat00 moreThanOne) Creates this message from a SecsFormat.

Method Summary

Modifier and Type	Method and Description
boolean	checkZeroLength(java.util.Vector temp) This allows the ALID to be zero length.
java.lang.Object[]	getStructure() Returns the required data types for this message.
java.lang.String	longName() Returns the long name for this object.
java.lang.String	shortName() Returns the short name for this object.
java.lang.String	theExceptionString() Returns a string description of the message exception.
boolean	toEquipment() Returns true since this method can be sent to the equipment.

Methods inherited from class com.ergotech.secs.SecsMsg

addResponseHandler, convertData, convertData, convertData, convertDataRecursive, convertException, createMsg, createSecsFormatObject, dateToString, getAbortTransaction, getAbortTransaction, getClassFromHeader, getData, getDataFormats, getDataFormatsRecursive, getDefaultReplyBit, getDeviceId, getError, getException, getFormattedBytes, getFunction, getIgnoreAllTimeouts, getIgnoreTimeouts, getMessageId, getMsgId, getMultiBlockRequest, getNACK, getPrimaryMessage, getReplyBit, getResponseMessage, getSessionManager, getShouldSendMultiBlockRequests, getStream, getSystemBytes, getTimeStamp, getTotalLength, getUnconvertedMsg, getUnrecoverableErrorHandler, handleResponseMessage, hasTimedOut, isConsideredMultiblock, isLastBlock, isMultiBlock, isReply, processSelf, registerMessageSpecificOutgoingVerifier, removeResponseHandler, replaceDataWith, responseTimedout, sendMessage, sendMessageAndWait, sendMessageInternal, setDeviceId, setFunction, setIgnoreAllTimeouts, setIgnoreTimeouts, setIsLastBlock, setMessageId, setPrimaryMessage, setReplyBit, setResponseMessage, SetSecsError, SetSecsError, setSessionManager, setShouldSendMultiBlockRequests, setStream, setSystemBytes, setTimeStamp, setUnconvertedMsg, setUnrecoverableErrorHandler, toHost, toString, waitForReply

Methods inherited from class java.lang.Object

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

Field Detail

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

Constructor Detail

S5F3

public S5F3()

Required empty constructor.

S5F3

public S5F3(ALED s1,
            ALID s2)

Creates this message from and ALED, ALID object. The objects are put into a SecsFormat00 object as the only entry.

S5F3

public S5F3(SecsFormat theData)

The data is assumed to be correct format and is not checked.

S5F3

public S5F3(SecsFormat00 moreThanOne)

Creates this message from a SecsFormat. The SecsFormat object should be of type SecsFormat00.

Method Detail

checkZeroLength

public boolean checkZeroLength(java.util.Vector temp)

This allows the ALID to be zero length.

Overrides:

checkZeroLength in class SecsMsg

getStructure

public java.lang.Object[] getStructure()

Returns the required data types for this message. In this case this a list of ALCD,ALID, ALTX objects.

Overrides:

getStructure in class SecsMsg

Returns:

the required data types.

See Also:

SecsMsg.getStructure()

longName

public java.lang.String longName()

Returns the long name for this object.

Overrides:

longName in class SecsMsg

Returns:

"Enable/Disable Alarm Send"

See Also:

SecsMsg.shortName()

shortName

public java.lang.String shortName()

Returns the short name for this object.

Overrides:

shortName in class SecsMsg

Returns:

"EAS"

See Also:

SecsMsg.longName()

theExceptionString

public java.lang.String theExceptionString()

Description copied from class: SecsMsg

Returns a string description of the message exception.

Overrides:

theExceptionString in class SecsMsg

toEquipment

public boolean toEquipment()

Returns true since this method can be sent to the equipment.

Overrides:

toEquipment in class SecsMsg

Returns:

true.