com.ergotech.secs

Class S1F3

java.lang.Object

com.ergotech.secs.SecsTrigger

com.ergotech.secs.SecsMsg

com.ergotech.secs.S1F3

All Implemented Interfaces:

java.io.Serializable

public class S1F3
extends SecsMsg

Selected Equipment Status Request. A request to the equipment to report selected values of its status. The format of this message is a list (Format00) of SVIDs.

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
S1F3() Required empty constructor.
S1F3(SecsFormat theData) The data is assumed to be correct format and is not checked.
S1F3(SecsFormat00 moreThanOne) Creates this message from a list of SVIDs.
S1F3(SVID onlyOne) Creates this message from one SVID.

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() This will return true if we have a null public boolean getAllRows() { return allRows; } /** Returns the long name for this object.
boolean	reply() We are expecting a S1F4
java.lang.String	shortName() Returns the short name for this object.
java.lang.String	theExceptionString() Returns a string description of the message exception.
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, 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, 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

S1F3

public S1F3()

Required empty constructor.

S1F3

public S1F3(SecsFormat theData)

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

S1F3

public S1F3(SecsFormat00 moreThanOne)

Creates this message from a list of SVIDs.

S1F3

public S1F3(SVID onlyOne)

Creates this message from one SVID. The SVID is put into a SecsFormat00 object as the only entry.

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 we are in a allRows state.

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 array of SVIDs.

Overrides:

getStructure in class SecsMsg

Returns:

the required data types.

See Also:

SecsMsg.getStructure()

longName

public java.lang.String longName()

This will return true if we have a null public boolean getAllRows() { return allRows; } /** Returns the long name for this object.

Overrides:

longName in class SecsMsg

Returns:

"Selected Equipment Status Request"

See Also:

SecsMsg.shortName()

reply

public boolean reply()

We are expecting a S1F4

shortName

public java.lang.String shortName()

Returns the short name for this object.

Overrides:

shortName in class SecsMsg

Returns:

"SSR"

See Also:

SecsMsg.longName()

theExceptionString

public java.lang.String theExceptionString()

Description copied from class: SecsMsg

Returns a string description of the message exception.

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.