com.ergotech.secs

Class S2F42

java.lang.Object

com.ergotech.secs.SecsTrigger

com.ergotech.secs.SecsMsg

com.ergotech.secs.S2F42

All Implemented Interfaces:

java.io.Serializable

public class S2F42
extends SecsMsg

Host Command Acknowledge (HCA). Acknowledge Host command or error. If command is not accepted due to one or more invalid parameters(i.e., HCACK=3), then a list of invalid parameters will be returned containing the parameter name and reason for being invalid. The format of this message is a list (Format00) of Format00s. L,2 1. 2. L,n # of parameters 1. L,2 1. parameter 1 name 2. parameter 1 reason . . n. L,2 1. parameter 1 name 2. parameter 1 reason

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
S2F42() Required empty constructor.
S2F42(HCACK s1, CPNAME s2, CPACK s3) Creates a new S2F41 message taking the data from the passed parameters.
S2F42(HCACK s1, CPNAME s2, SecsFormat00 l1) Creates a new S2F42 message taking the data from the passed parameters.
S2F42(SecsFormat theData) The data is assumed to be correct format and is not checked.
S2F42(SecsFormat00 moreThanOne) Creates this message from a list (Format00) of constants containing an RCMD, CPNAME, and CPVALUE.

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

S2F42

public S2F42()

Required empty constructor.

S2F42

public S2F42(HCACK s1,
             CPNAME s2,
             CPACK s3)

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

S2F42

public S2F42(HCACK s1,
             CPNAME s2,
             SecsFormat00 l1)

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

S2F42

public S2F42(SecsFormat theData)

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

S2F42

public S2F42(SecsFormat00 moreThanOne)

Creates this message from a list (Format00) of constants containing an RCMD, CPNAME, and CPVALUE.

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 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 a SecsFormat00 message containing an LOC, a PPID and an array of MIDs.

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:

"Host Command Acknowledge"

See Also:

SecsMsg.shortName()

shortName

public java.lang.String shortName()

Returns the short name for this object.

Overrides:

shortName in class SecsMsg

Returns:

"HCA"

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

toHost

public boolean toHost()

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

Overrides:

toHost in class SecsMsg

Returns:

true.