com.ergotech.secs

Class S5F5

java.lang.Object

com.ergotech.secs.SecsTrigger

com.ergotech.secs.SecsMsg

com.ergotech.secs.S5F5

All Implemented Interfaces:

java.io.Serializable

public class S5F5
extends SecsMsg

List Alarm Request (LAR). This message request the equipment to send binary and analog alarm information to the host. The format of this message is a list (SecsFormat00) of 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, SPOOLED, TIMEOUT_ERROR, towerAkrion, UNSOLICITED

Constructor Summary

Constructors

Constructor and Description
S5F5() Required empty constructor.
S5F5(ALID s1) Creates this message from and ALED, ALID object.
S5F5(SecsFormat theData) The data is assumed to be correct format and is not checked.
S5F5(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 variables to be zero length.
boolean	convertException(SecsFormat temp) This will check for exceptions in the structure.
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, createMsg, createSecsFormatObject, dateToString, getAbortTransaction, getAbortTransaction, getClassFromHeader, getData, getDataFormats, getDataFormatsRecursive, getDefaultReplyBit, getDetailedSML, getDeviceId, getError, getException, getFormattedBytes, getFunction, getIgnoreAllTimeouts, getIgnoreTimeouts, getMessageId, getMsgId, getMultiBlockRequest, getNACK, getPrimaryMessage, getReplyBit, getResponseMessage, getSessionManager, getShouldSendMultiBlockRequests, getStream, getSystemBytes, getTimeStamp, getTotalLength, getUnconvertedMsg, getUniqueSystemBytes, getUnrecoverableErrorHandler, handleResponseMessage, hasTimedOut, isConsideredMultiblock, isLastBlock, isMultiBlock, isReply, notifyResponse, processSelf, registerMessageSpecificOutgoingVerifier, removeResponseHandler, replaceDataWith, responseTimedout, sendMessage, sendMessageAndWait, sendMessageInternal, setDetailedSML, 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

S5F5

public S5F5()

Required empty constructor.

S5F5

public S5F5(ALID s1)

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

S5F5

public S5F5(SecsFormat theData)

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

S5F5

public S5F5(SecsFormat00 moreThanOne)
     throws SecsException

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

Throws:

SecsException

Method Detail

checkZeroLength

public boolean checkZeroLength(java.util.Vector temp)

This allows the variables to be zero length.

Overrides:

checkZeroLength in class SecsMsg

convertException

public boolean convertException(SecsFormat temp)
                         throws SecsException

This will check for exceptions in the structure. We are specifically checking to see if we are in a allRows state.

Overrides:

convertException in class SecsMsg

Throws:

SecsException

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:

"List Alarm Request"

See Also:

SecsMsg.shortName()

shortName

public java.lang.String shortName()

Returns the short name for this object.

Overrides:

shortName in class SecsMsg

Returns:

"LAR"

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.