com.ergotech.secs

Class S2F23

java.lang.Object

com.ergotech.secs.SecsTrigger

com.ergotech.secs.SecsMsg

com.ergotech.secs.S2F23

All Implemented Interfaces:

java.io.Serializable

public class S2F23
extends SecsMsg

Trace Initialize Send. Status variables exist at all times. This function provides a way to sample a subset of those status variables as a function of time. The trace data is returned on S6F1 and is related to the original request by the TRID. Multiple trace requests may be made to that equipment allowing it. I equipment receives S2F23 with the same TRID as a trace function that is currently in progress, the equipment should terminate the old trace and then initiate the new trace. A trace function currently in progress may be terminated by S2F23 and TRID of that trace and TOTSMP=0. 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, TIMEOUT_ERROR, UNSOLICITED

Constructor Summary

Constructors

Constructor and Description
S2F23()
S2F23(SecsFormat theData) The data is assumed to be correct format and is not checked.
S2F23(SecsFormat00 moreThanOne) Creates this message from a list (Format00) of constants containing a TRID, DSPER, TOTSMP,REPGSZ and a list of SVIDs.
S2F23(TRID s1, DSPER s2, TOTSMP s3, REPGSZ s4, SecsFormat00 l1) Creates a new S2F23 message taking the data from the passed parameters.
S2F23(TRID s1, DSPER s2, TOTSMP s3, REPGSZ s4, SVID s5) Creates a new S2F23 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.

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

S2F23

public S2F23()

S2F23

public S2F23(SecsFormat theData)

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

S2F23

public S2F23(SecsFormat00 moreThanOne)

Creates this message from a list (Format00) of constants containing a TRID, DSPER, TOTSMP,REPGSZ and a list of SVIDs.

S2F23

public S2F23(TRID s1,
             DSPER s2,
             TOTSMP s3,
             REPGSZ s4,
             SecsFormat00 l1)

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

S2F23

public S2F23(TRID s1,
             DSPER s2,
             TOTSMP s3,
             REPGSZ s4,
             SVID s5)

Creates a new S2F23 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 SecsFormat00 message containing a TRID, DSPER, TOTSMP,REPGSZ and a list of SVIDs.

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:

"Trace Initialize Send"

See Also:

SecsMsg.shortName()

shortName

public java.lang.String shortName()

Returns the short name for this object.

Overrides:

shortName in class SecsMsg

Returns:

"TIS"

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.