com.ergotech.secs

Class S2F33

java.lang.Object

com.ergotech.secs.SecsTrigger

com.ergotech.secs.SecsMsg

com.ergotech.secs.S2F33

All Implemented Interfaces:

java.io.Serializable

public class S2F33
extends SecsMsg

Define Report. The purpose of this message is for the host to define a groupof reports for the equipment.

The type of report to be transmitted is designated by a Boolean "Equipment Constant". An "Equipment Constant Value" of "False" means that an "Event Report" (S6F11) will be sent, and a value of "True" means tha an "Annotated Event Report" (S6F13) will be sent. If S2F33 is Multi-block, it must be preceded by the S2F39/S2F40 Inquire/Grant transaction.

The format of this message is a list (Format00) of Format00s.

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
S2F33()
S2F33(SecsFormat theData) The data is assumed to be correct format and is not checked.
S2F33(SecsFormat00 moreThanOne) Creates this message from a list (Format00) of constants containing an DATAID, then a list containing a list of RPTID and a list of VIDs

Method Summary

Modifier and Type	Method and Description
boolean	convertException(SecsFormat temp) This will check for exceptions in the structure.
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	toEquipment() Returns true since this method can be sent to the equipment.
java.lang.String	toSML(GemHandler gemHandler) Create a documented SML string for the message.

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

S2F33

public S2F33()

S2F33

public S2F33(SecsFormat theData)

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

S2F33

public S2F33(SecsFormat00 moreThanOne)

Creates this message from a list (Format00) of constants containing an DATAID, then a list containing a list of RPTID and a list of VIDs

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

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 an ECID and a ECV.

Overrides:

getStructure in class SecsMsg

Returns:

the required data types {new Object[] { "DATAID", new Object[] { new Object[] { "RPTID", new Object [] {"VID"}}}}};)

See Also:

SecsMsg.getStructure()

longName

public java.lang.String longName()

Returns the long name for this object.

Overrides:

longName in class SecsMsg

Returns:

"Define Report"

See Also:

SecsMsg.shortName()

shortName

public java.lang.String shortName()

Returns the short name for this object.

Overrides:

shortName in class SecsMsg

Returns:

"DR"

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.

toSML

public java.lang.String toSML(GemHandler gemHandler)

Create a documented SML string for the message. For example: S2F33 W DATAID \ Report ID > > > . S2F33 W DATAID CLOCK ControlState GasFlow LOTID > > > > .

Parameters:

gemHandler - the gem handler which will handle the request

Returns:

a documented sml string (also stored as the detailed sml in the message)