com.ergotech.secs

Class S2F1

java.lang.Object

com.ergotech.secs.SecsTrigger

com.ergotech.secs.SecsMsg

com.ergotech.secs.MultiBlockRequest

com.ergotech.secs.S2F1

All Implemented Interfaces:

MessageResponseInterface, java.io.Serializable

public class S2F1
extends MultiBlockRequest

This message is used to initiate the transfer of a process program or to select from stored programs. It is mandatory if the process program is multi-block and is twinned with "Service Program Load Grant" (S2F2) in this case. The transfer of the process program is achieved by messages S2 F3,4, and others. The format of this message is a list containing a SPID and a LENGTH representing the length of the message to be sent.

See Also:

S2F2, S2F3, 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
S2F1() Required empty constructor.
S2F1(SecsFormat theData) The data is assumed to be correct format and is not checked.
S2F1(SPID s1, LENGTH s2) Creates a new S2F1 message taking the data from the passed parameters.

Method Summary

Modifier and Type	Method and Description
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.
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, checkZeroLength, convertData, convertData, convertData, convertDataRecursive, convertException, 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, theExceptionString, 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

S2F1

public S2F1()

Required empty constructor.

S2F1

public S2F1(SecsFormat theData)

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

S2F1

public S2F1(SPID s1,
            LENGTH s2)

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

Method Detail

getStructure

public java.lang.Object[] getStructure()

Returns the required data types for this message. In this case this is a SPID and a LENGTH.

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:

"Process Program Load Inquire"

See Also:

SecsMsg.shortName()

shortName

public java.lang.String shortName()

Returns the short name for this object.

Overrides:

shortName in class SecsMsg

Returns:

"SPI"

See Also:

SecsMsg.longName()

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.