com.ergotech.secs

Class S1F14

java.lang.Object

com.ergotech.secs.SecsTrigger

com.ergotech.secs.SecsMsg

com.ergotech.secs.S1F14

All Implemented Interfaces:

java.io.Serializable

public class S1F14
extends SecsMsg

Establish Communications Request Acknowledge. Data response to S1F13. Accept or deby Establish Communications Request (S1F13). MDLN and SOFTREV are on-line data and are valid only if COMMACK=0. The format of this message is a list (Format00) of Format00s.

See Also:

S1F13, 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
S1F14() Required empty constructor.
S1F14(byte ack, SecsFormat originalInfo) Creates a new message taking the data from the passed parameters.
S1F14(COMMACK sack, MDLN s1, SOFTREV s2) Creates a new message taking the data from the passed parameters.
S1F14(SecsFormat theData) The data is assumed to be correct format and is not checked.
S1F14(SecsFormat00 moreThanOne) Creates this message from a list.

Method Summary

Modifier and Type	Method and Description
boolean	ack() Returns whether the COMMACK contained a zero (valid ack) or a non-zero value (error report).
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.
boolean	processSelf(java.lang.Object messageHandler) This method overrides the SecsMsg method.
java.lang.String	shortName() Returns the short name for this object.
java.lang.String	theExceptionString() Exception string as defined by the SEMI standard.
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.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, isMultiBlock, isReply, notifyResponse, 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, 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

S1F14

public S1F14()

Required empty constructor.

S1F14

public S1F14(byte ack,
             SecsFormat originalInfo)

Creates a new message taking the data from the passed parameters.

S1F14

public S1F14(COMMACK sack,
             MDLN s1,
             SOFTREV s2)

Creates a new message taking the data from the passed parameters.

S1F14

public S1F14(SecsFormat theData)

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

S1F14

public S1F14(SecsFormat00 moreThanOne)

Creates this message from a list.

Method Detail

ack

public boolean ack()

Returns whether the COMMACK contained a zero (valid ack) or a non-zero value (error report).

convertException

public boolean convertException(SecsFormat temp)
                         throws SecsException

This will check for exceptions in the structure. We are specifically checking to see if this was sent from the host.

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 is an COMMACK and a SecsFormat00 message containing an MDLN and a SOFTREV.

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:

"Establish Communications Request Acknowledge"

See Also:

SecsMsg.shortName()

processSelf

public boolean processSelf(java.lang.Object messageHandler)
                    throws SecsException

This method overrides the SecsMsg method. It will call supers processSelf that will send the message to the message handler. But we will also notify that SessionManager that we are now communicating.

Overrides:

processSelf in class SecsMsg

Throws:

SecsException

See Also:

SessionManager.createMessage(byte[])

shortName

public java.lang.String shortName()

Returns the short name for this object.

Overrides:

shortName in class SecsMsg

Returns:

"CRA"

See Also:

SecsMsg.longName()

theExceptionString

public java.lang.String theExceptionString()

Exception string as defined by the SEMI standard.

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.