com.ergotech.secs

Class S0F0

java.lang.Object

com.ergotech.secs.SecsTrigger

com.ergotech.secs.SecsMsg

com.ergotech.secs.S0F0

All Implemented Interfaces:

java.io.Serializable

public class S0F0
extends SecsMsg

A general purpose method. This will not check the format of the message either outgoing or incoming so can be used for anything.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	cvsRev
int	function The function of this message (default is zero).
int	stream The stream of this message (default is zero).

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
S0F0() The required default constructor.
S0F0(int stream, int function, boolean wBit, SecsFormat theData) Create the object with some useful parameters.
S0F0(SecsFormat theData) The data is assumed to be correct format and is not checked.

Method Summary

Modifier and Type	Method and Description
SecsFormat	getData() Returns the message as a SecsFormat.
int	getFunction() Returns the function of this message.
int	getStream() Returns the stream number of this message.
void	setFunction(int newValue) Sets the function number of this message.
void	setStream(int newValue) Sets the stream number of this message.

Methods inherited from class com.ergotech.secs.SecsMsg

addResponseHandler, checkZeroLength, convertData, convertData, convertData, convertDataRecursive, convertException, createMsg, createSecsFormatObject, dateToString, getAbortTransaction, getAbortTransaction, getClassFromHeader, getDataFormats, getDataFormatsRecursive, getDefaultReplyBit, getDetailedSML, getDeviceId, getError, getException, getFormattedBytes, getIgnoreAllTimeouts, getIgnoreTimeouts, getMessageId, getMsgId, getMultiBlockRequest, getNACK, getPrimaryMessage, getReplyBit, getResponseMessage, getSessionManager, getShouldSendMultiBlockRequests, getStructure, getSystemBytes, getTimeStamp, getTotalLength, getUnconvertedMsg, getUniqueSystemBytes, getUnrecoverableErrorHandler, handleResponseMessage, hasTimedOut, isConsideredMultiblock, isLastBlock, isMultiBlock, isReply, longName, notifyResponse, processSelf, registerMessageSpecificOutgoingVerifier, removeResponseHandler, replaceDataWith, responseTimedout, sendMessage, sendMessageAndWait, sendMessageInternal, setDetailedSML, setDeviceId, setIgnoreAllTimeouts, setIgnoreTimeouts, setIsLastBlock, setMessageId, setPrimaryMessage, setReplyBit, setResponseMessage, SetSecsError, SetSecsError, setSessionManager, setShouldSendMultiBlockRequests, setSystemBytes, setTimeStamp, setUnconvertedMsg, setUnrecoverableErrorHandler, shortName, theExceptionString, toEquipment, 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

function

public int function

The function of this message (default is zero).

stream

public int stream

The stream of this message (default is zero).

Constructor Detail

S0F0

public S0F0()

The required default constructor.

S0F0

public S0F0(int stream,
            int function,
            boolean wBit,
            SecsFormat theData)
     throws SecsException

Create the object with some useful parameters.

Parameters:

stream - the stream of this object

function - the function of this object

wBit - the value for the W bit

theData - the data to be sent as this message

Throws:

SecsException

S0F0

public S0F0(SecsFormat theData)

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

Method Detail

getData

public SecsFormat getData()
                   throws SecsException

Returns the message as a SecsFormat. Used when the message is received.

Overrides:

getData in class SecsMsg

Returns:

the message

Throws:

SecsException

See Also:

SecsFormat00

getFunction

public int getFunction()

Returns the function of this message.

Overrides:

getFunction in class SecsMsg

Returns:

y in SxFy

getStream

public int getStream()

Returns the stream number of this message.

Overrides:

getStream in class SecsMsg

Returns:

x in SxFy

setFunction

public void setFunction(int newValue)

Sets the function number of this message.

Overrides:

setFunction in class SecsMsg

Parameters:

newValue - the function number.

setStream

public void setStream(int newValue)

Sets the stream number of this message.

Overrides:

setStream in class SecsMsg

Parameters:

newValue - the stream number