com.ergotech.secs

Class S6F11

java.lang.Object

com.ergotech.secs.SecsTrigger

com.ergotech.secs.SecsMsg

com.ergotech.secs.S6F11

All Implemented Interfaces:

java.io.Serializable

public class S6F11
extends SecsMsg

Event Report Send (ERS). The purpose of this message is for the equipment to send a defined, linked, and enabled group of reports to the host upon the occurrence of an event (CEID) The format of this message is a list (Format00) of Format00s. L, 3 1. 2. 3. L, a 1. L,2 1. 2. L,b 1. L,2 1. . . b. . . a. L,2 report a 1. 2. L,c#Vs this report 1. L,2 1. . . c.

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
S6F11() Required empty constructor.
S6F11(DATAID s1, CEID s2, RPTID s3, V s4) Creates a new S6F11 message taking the data from the passed parameters.
S6F11(SecsFormat theData) The data is assumed to be correct format and is not checked.
S6F11(SecsFormat00 theData) Creates this message from one SecsFormat00.

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.
java.lang.String	theExceptionString() Returns a string description of the message exception.
boolean	toHost() Returns true since this method can be sent to the host.
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, 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

S6F11

public S6F11()

Required empty constructor.

S6F11

public S6F11(DATAID s1,
             CEID s2,
             RPTID s3,
             V s4)

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

S6F11

public S6F11(SecsFormat theData)

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

S6F11

public S6F11(SecsFormat00 theData)

Creates this message from one SecsFormat00.

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

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.

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:

"Event Report Send"

See Also:

SecsMsg.shortName()

shortName

public java.lang.String shortName()

Returns the short name for this object.

Overrides:

shortName in class SecsMsg

Returns:

"ERS"

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

toHost

public boolean toHost()

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

Overrides:

toHost in class SecsMsg

Returns:

true.

toSML

public java.lang.String toSML(GemHandler gemHandler)

Create a documented SML string for the message. For example: S6F11 W > > > > .

Parameters:

gemHandler - the gem handler which will handle the request

Returns:

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