com.ergotech.secs

Class S2F48

java.lang.Object

com.ergotech.secs.SecsTrigger

com.ergotech.secs.SecsMsg

com.ergotech.secs.S2F48

All Implemented Interfaces:

java.io.Serializable

public class S2F48
extends SecsMsg

Variable Limit Attributes Send (VLAS). Equipment sends values of requested variable limit attribute definitions in the order requested. The format of this message is a list (Format00) of Format00s. L,m (m=# VIDs this request) 1. L,2 1. 2. L,p {p=0,4} 1. 2. 3. 4. L,n (n=# of limits defined for this VID) 1. L,3 1. 2. 3. . . n. L,3 1. 2. 3. . . m. L,2 1. 2. L,p {p=0,4} 1. 2. 3. 4. L,n (n=# of limits defined for this VID) 1. L,3 1. 2. 3. . . n. L,3 1. 2. 3.

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
S2F48() Required empty constructor.
S2F48(SecsFormat theData) The data is assumed to be correct format and is not checked.
S2F48(SecsFormat00 moreThanOne) Creates this message from a list (Format00) of constants containing VID, UNITS, LIMITMIN, LIMITMAX, LIMITID, UPPERDB, LOWERDB
S2F48(VID s1, UNITS s2, LIMITMIN s3, LIMITMAX s4, LIMITID s5, UPPERDB s6, LOWERDB s7) Creates a new S2F48 message taking the data from the passed parameters.

Method Summary

Modifier and Type	Method and Description
boolean	checkZeroLength(java.util.Vector theFormats) Return true.
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() 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	toHost() Returns true since this method can be sent to the equipment.

Methods inherited from class com.ergotech.secs.SecsMsg

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

S2F48

public S2F48()

Required empty constructor.

S2F48

public S2F48(SecsFormat theData)

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

S2F48

public S2F48(SecsFormat00 moreThanOne)

Creates this message from a list (Format00) of constants containing VID, UNITS, LIMITMIN, LIMITMAX, LIMITID, UPPERDB, LOWERDB

S2F48

public S2F48(VID s1,
             UNITS s2,
             LIMITMIN s3,
             LIMITMAX s4,
             LIMITID s5,
             UPPERDB s6,
             LOWERDB s7)

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

Method Detail

checkZeroLength

public boolean checkZeroLength(java.util.Vector theFormats)

Return true. The units are often zero length which is not an error.

Overrides:

checkZeroLength in class SecsMsg

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

getStructure

public java.lang.Object[] getStructure()

Returns the required data types for this message. In this case this is a SecsFormat00 message containing VID, UNITS, LIMITMIN, LIMITMAX, LIMITID, UPPERDB, LOWERDB.

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:

"Variable Limit Attributes Send"

See Also:

SecsMsg.shortName()

shortName

public java.lang.String shortName()

Returns the short name for this object.

Overrides:

shortName in class SecsMsg

Returns:

"VLAS"

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

toHost

public boolean toHost()

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

Overrides:

toHost in class SecsMsg

Returns:

true.