com.ergotech.secs

Class S9F9

java.lang.Object

com.ergotech.secs.SecsTrigger

com.ergotech.secs.SecsMsg

com.ergotech.secs.S9F9

All Implemented Interfaces:

java.io.Serializable

public class S9F9
extends SecsMsg

Transaction Timer Timeout (TTN). This message indicates that a transaction (receive) timer has timed out and that the corresponding transaction has been aborted. It is up to the host to respond to this error in an appropriate manner to keep the system operational. The format of this message is an SHEAD.

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
S9F9() Required empty constructor.
S9F9(SecsFormat theData) The data is assumed to be correct format and is not checked.
S9F9(SecsMsg receivedMessage) Creates this message from the message that caused the error.
S9F9(SHEAD theData) Creates this message from one SHEAD.

Method Summary

Modifier and Type	Method and Description
boolean	getDefaultReplyBit() Returns false.
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.
boolean	toHost() Returns true since this method can be sent to the equipment.

Methods inherited from class com.ergotech.secs.SecsMsg

addResponseHandler, checkZeroLength, convertData, convertData, convertData, convertDataRecursive, convertException, createMsg, createSecsFormatObject, dateToString, getAbortTransaction, getAbortTransaction, getClassFromHeader, getData, getDataFormats, getDataFormatsRecursive, 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, theExceptionString, toEquipment, 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

S9F9

public S9F9()

Required empty constructor.

S9F9

public S9F9(SecsFormat theData)

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

S9F9

public S9F9(SecsMsg receivedMessage)

Creates this message from the message that caused the error.

S9F9

public S9F9(SHEAD theData)

Creates this message from one SHEAD.

Method Detail

getDefaultReplyBit

public boolean getDefaultReplyBit()

Returns false. There is no reply to this message.

Overrides:

getDefaultReplyBit in class SecsMsg

Returns:

the default setting for the W-bit.

See Also:

SecsMsg.getReplyBit(), SecsMsg.setReplyBit(boolean)

getStructure

public java.lang.Object[] getStructure()

Returns the required data types for this message. In this case this an SHEAD.

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:

"Transaction Timer Timeout"

See Also:

SecsMsg.shortName()

shortName

public java.lang.String shortName()

Returns the short name for this object.

Overrides:

shortName in class SecsMsg

Returns:

"TTN"

See Also:

SecsMsg.longName()

toHost

public boolean toHost()

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

Overrides:

toHost in class SecsMsg

Returns:

true.