com.ergotech.secs

Class S2F49

java.lang.Object

com.ergotech.secs.SecsTrigger

com.ergotech.secs.SecsMsg

com.ergotech.secs.S2F49

All Implemented Interfaces:

java.io.Serializable

public class S2F49
extends SecsMsg

Enhanced Remote Command ( ). The host requests an object to perform the specified remote command with its associated parameters. If multi-block, it shall be preceded by the S2F39/F40 Multi-Block Inquire/Grant transaction. The format of this message is a list (Format00) of Format00s. L,4 1. 2. 3. 4. L,m # of parameter groups 1. L,2 1. command parameter 1 name 2. command enchanced parameter 1 value 2. L,2 1. command parameter 2 name 2. command enhaced parameter 2 value . . m. L,2 1. command parameter m name 2. command enhaced parameter m value If a specific value of CPNAME is defined to have a CEPVAL defined as LIST it shall always be a LIST. If the CEPVAL that is assiciated to that specific value of CPNAME is defined to ba anything other than LIST, it will result in a format error.

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
S2F49() Required empty constructor.
S2F49(DATAID s1, OBJSPEC s2, RCMD s3, CPNAME s4, CEPVAL s5) Creates a new S2F49 message taking the data from the passed parameters.
S2F49(SecsFormat theData) The data is assumed to be correct format and is not checked.
S2F49(SecsFormat00 moreThanOne) Creates this message from a list (Format00) of constants containing DATAID, OBJSPEC, RCMD, CPNAME, CEPVAL

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() The description of the exception defined by the SEMI specification.
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, 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

S2F49

public S2F49()

Required empty constructor.

S2F49

public S2F49(DATAID s1,
             OBJSPEC s2,
             RCMD s3,
             CPNAME s4,
             CEPVAL s5)

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

S2F49

public S2F49(SecsFormat theData)

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

S2F49

public S2F49(SecsFormat00 moreThanOne)

Creates this message from a list (Format00) of constants containing DATAID, OBJSPEC, RCMD, CPNAME, CEPVAL

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 DATAID, OBJSPEC, RCMD, CPNAME, CEPVAL

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:

"Enhanced Remote Command"

See Also:

SecsMsg.shortName()

shortName

public java.lang.String shortName()

Returns the short name for this object.

Overrides:

shortName in class SecsMsg

Returns:

" "

See Also:

SecsMsg.longName()

theExceptionString

public java.lang.String theExceptionString()

The description of the exception defined by the SEMI specification.

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.