com.ergotech.secs

Class S6F9

java.lang.Object

com.ergotech.secs.SecsTrigger

com.ergotech.secs.SecsMsg

com.ergotech.secs.S6F9

All Implemented Interfaces:

java.io.Serializable

public class S6F9
extends SecsMsg

Formatted variable Send (FVS). The same function as S6, F3 except that the DVNAMEs are supplied from a predefined form that is known to the host. Thus, the data are more compact if S6, F9 is multi-block, it must be preceded by the S6,F5/S6,F6 Inquire/Grant transaction. The format of this message is a list (Format00) of Format00s. L, 4 1. 2. 3. 4. L, n 1. L,2 1. 2. L,M 1. . . m. 2. L,2 . . n. L,2 1. 2. etc.

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
S6F9() Required empty constructor.
S6F9(SecsFormat theData) The data is assumed to be correct format and is not checked.
S6F9(SecsFormat00 moreThanOne) Creates this message from a list (Format00) of constants containing PFCD, DATAID, CEID, DSID, DVVAL.

Method Summary

Modifier and Type	Method and Description
MultiBlockRequest	getMultiBlockRequest() This is the multiblock message we will send if we have auto-multiblock setup.
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	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, convertException, createMsg, createSecsFormatObject, dateToString, getAbortTransaction, getAbortTransaction, getClassFromHeader, getData, getDataFormats, getDataFormatsRecursive, getDefaultReplyBit, getDeviceId, getError, getException, getFormattedBytes, getFunction, getIgnoreAllTimeouts, getIgnoreTimeouts, getMessageId, getMsgId, 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, theExceptionString, 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

S6F9

public S6F9()

Required empty constructor.

S6F9

public S6F9(SecsFormat theData)

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

S6F9

public S6F9(SecsFormat00 moreThanOne)

Creates this message from a list (Format00) of constants containing PFCD, DATAID, CEID, DSID, DVVAL.

Method Detail

getMultiBlockRequest

public MultiBlockRequest getMultiBlockRequest()

This is the multiblock message we will send if we have auto-multiblock setup.

Overrides:

getMultiBlockRequest in class SecsMsg

getStructure

public java.lang.Object[] getStructure()

Returns the required data types for this message. In this case this is a SecsFormat00 message containing PFCD, DATAID, CEID, DSID, DVVAL.

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:

"Formatted variable Send"

See Also:

SecsMsg.shortName()

shortName

public java.lang.String shortName()

Returns the short name for this object.

Overrides:

shortName in class SecsMsg

Returns:

"FVS"

See Also:

SecsMsg.longName()

toHost

public boolean toHost()

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

Overrides:

toHost in class SecsMsg

Returns:

true.