com.ergotech.secs

Class S1F6

java.lang.Object

com.ergotech.secs.SecsTrigger

com.ergotech.secs.SecsMsg

com.ergotech.secs.S1F6

All Implemented Interfaces:

java.io.Serializable

public class S1F6
extends SecsMsg
implements java.io.Serializable

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
S1F6()
S1F6(SecsFormat theData) The data is assumed to be correct format and is not checked.

Method Summary

Modifier and Type	Method and Description
boolean	convertException(SecsFormat temp) This will check for exceptions in the structure.
java.lang.Object[]	getStructure() Returns an array of objects representing the required structure for the message.
boolean	isMultiBlock() Returns true if this message is multi-block.
java.lang.String	longName() Returns the long name for this message.
java.lang.String	shortName() Returns the short name for this message.
java.lang.String	theExceptionString() Exception string as defined by the SEMI standard.
boolean	toHost() Returns true if this message is intended to be sent to the host.

Methods inherited from class com.ergotech.secs.SecsMsg

addResponseHandler, checkZeroLength, 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, 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, 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

S1F6

public S1F6()

S1F6

public S1F6(SecsFormat theData)

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

Method Detail

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()

Description copied from class: SecsMsg

Returns an array of objects representing the required structure for the message. The array will usually contain strings or an array of objects. The strings are the class names of the expected data struture (SecsDataStructure). The array of objects is used to represent the structure of an array (SecsFormat00) and recursively contains the same types of elements as this array. This default method returns null which is for objects that don't store any data (header only)

Overrides:

getStructure in class SecsMsg

See Also:

SecsDataStructure

isMultiBlock

public boolean isMultiBlock()

Description copied from class: SecsMsg

Returns true if this message is multi-block. This will use the session manager of the message, if set, or the default session manager.

Overrides:

isMultiBlock in class SecsMsg

longName

public java.lang.String longName()

Description copied from class: SecsMsg

Returns the long name for this message. By default this returns an empty string. It is the responsibility of subclasses to provide a meaningful value. The short name is identified by the SECS II specification. For example, the S1F3 message is identified by the long name "Selected Equipment Status Request" and by the short name "SSR".

Overrides:

longName in class SecsMsg

See Also:

SecsMsg.shortName()

shortName

public java.lang.String shortName()

Description copied from class: SecsMsg

Returns the short name for this message. By default this returns a SxFy derived from the classname if possible. If the format of the class name is incorrect then this method return and empty string. It is the responsibility of subclasses to provide a meaningful value. The short name is identified by the SECS II specification. For example, the S1F3 message is identified by the long name "Selected Equipment Status Request" and by the short name "SSR".

Overrides:

shortName in class SecsMsg

See Also:

SecsMsg.longName()

theExceptionString

public java.lang.String theExceptionString()

Exception string as defined by the SEMI standard.

Overrides:

theExceptionString in class SecsMsg

toHost

public boolean toHost()

Description copied from class: SecsMsg

Returns true if this message is intended to be sent to the host. This is only relevant for SECS1, all other protocols return true.

Overrides:

toHost in class SecsMsg