com.ergotech.secs

Class S2F43

java.lang.Object

com.ergotech.secs.SecsTrigger

com.ergotech.secs.SecsMsg

com.ergotech.secs.S2F43

All Implemented Interfaces:

java.io.Serializable

public class S2F43
extends SecsMsg

Reset Spooling Streams and Function (RSSF). The message allows the host to select specific streams and functions to be spooled whenever spooling is active. The format of this message is a list (Format00) of Format00s. L,m 1. L,2 1. 2. L,n 1. parameter 1 name . . n. . . m. L,2 1. 2. L,n 1. parameter 1 name . . . Notes: 1. Turning off spooling for all functions for a specific stream is achieved by ommitting reference to the stream from this message. 2. Spooling for Stream 1 is not allowed. 3. Equipment must allow host to spool all primary messages for a stream (except Stream 1). 4. A defined list of functions for a stream in this message will replace any prebiously selected functions.

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

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	toEquipment() 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, 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, toHost, 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

S2F43

public S2F43()

Required empty constructor.

S2F43

public S2F43(SecsFormat theData)

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

S2F43

public S2F43(SecsFormat00 moreThanOne)

Creates this message from a list (Format00) of constants containing an STRID, FCNID.

S2F43

public S2F43(STRID s1,
             FCNID l1)

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

S2F43

public S2F43(STRID s1,
             SecsFormat00 l1)

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

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:

"Reset Spooling Streams and Function"

See Also:

SecsMsg.shortName()

shortName

public java.lang.String shortName()

Returns the short name for this object.

Overrides:

shortName in class SecsMsg

Returns:

"RSSF"

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.