com.ergotech.secs

Class S15F1

java.lang.Object

com.ergotech.secs.SecsTrigger

com.ergotech.secs.SecsMsg

com.ergotech.secs.MultiBlockRequest

com.ergotech.secs.S15F1

All Implemented Interfaces:

MessageResponseInterface, java.io.Serializable

public class S15F1
extends MultiBlockRequest

On Line Data. Data signifying that the equipment is alive. The format of this message is a list (SecsFormat00) of MDLN and SOFTREV 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
S15F1() Required empty constructor.
S15F1(DATAID s1, RCPSPEC s2, RMDATASIZE s3) Creates this message from and MDLN and a SOFTREV object.
S15F1(SecsFormat theData) The data is assumed to be correct format and is not checked.

Method Summary

Modifier and Type	Method and Description
boolean	checkZeroLength(java.util.Vector theFormats) Implemented by subclasses.
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() The description of the exception defined by the SEMI specification.
boolean	toEquipment() Returns true since this method can be sent to the equipment.
boolean	toHost() Returns true since this method can be sent to the host.

Methods inherited from class com.ergotech.secs.MultiBlockRequest

responseReceived, sendMultiBlockMsg

Methods inherited from class com.ergotech.secs.SecsMsg

addResponseHandler, convertData, convertData, convertData, convertDataRecursive, 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, 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

S15F1

public S15F1()

Required empty constructor.

S15F1

public S15F1(DATAID s1,
             RCPSPEC s2,
             RMDATASIZE s3)

Creates this message from and MDLN and a SOFTREV object. The objects are put into a SecsFormat00 object as the only entry.

S15F1

public S15F1(SecsFormat theData)

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

Method Detail

checkZeroLength

public boolean checkZeroLength(java.util.Vector theFormats)

Description copied from class: SecsMsg

Implemented by subclasses. Can return "false" to indicate that zero length items are not acceptable.

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.

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:

"On Line Data"

See Also:

SecsMsg.shortName()

shortName

public java.lang.String shortName()

Returns the short name for this object.

Overrides:

shortName in class SecsMsg

Returns:

"none"

See Also:

SecsMsg.longName()

theExceptionString

public java.lang.String theExceptionString()

The description of the exception defined by the SEMI specification.

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.

toHost

public boolean toHost()

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

Overrides:

toHost in class SecsMsg

Returns:

true.