com.ergotech.transsecs.secs

Interface SecsDefinedMessage

All Known Implementing Classes:

Alarm, AlarmAck, AlarmEnableAck, ALIDListRequest, ALIDListResponse, AllALIDListResponse, AreYouThereFromHost, AreYouThereFromTool, AreYouThereResponseFromHost, AreYouThereResponseFromTool, CEIDListRequest, CEIDListResponse, CEIDReportsRequest, CEIDReportsResponse, CreateReports, CreateReportsResponse, DeleteReport, DeleteReports, DisableEvents, DisableSpooling, DVIDListRequest, DVIDListResponse, ECIDListRequest, ECIDListResponse, ECIDValueRequest, ECIDValueResponse, EnableAlarm, EnableAllAlarms, EnableAllEvents, EnabledAlarmsListRequest, EnabledAlarmsListResponse, EnableDisableEvents, EnableEvents, EnableEventsResponse, EnableEventsResponse, EquipmentConstantData, EstablishCommunications, EstablishCommunicationsFromTool, EstablishCommunicationsResponse, EstablishCommunicationsResponseToTool, EventMessage, EventMessageACK, EventMessageDecoder, EventMinimumMessage, EventReportData, EventReportRequest, IndividualReportData, InvalidDeviceId, LinkReports, LinkReportsResponse, MultiblockGrant, MultiblockRequest, OnlineAck, RequestOnline, SelectedEquipmentStatusData, SendS1F3Poll, SpoolDataRequest, Stream9, SVIDListRequest, SVIDListResponse, SVIDValueRequest, SVIDValueResponse, TraceData, TraceDataACK, TraceInitializationSend, UnlinkReports, VIBInMessageBean, VIBInOutMessageBean, VIBMessageBean, VIBOutMessageBean

public interface SecsDefinedMessage

Remote interface for the Message superclass

Method Summary

Modifier and Type	Method and Description
SecsMsg	createMessage() Create the message.
int	getFunction() This will return the function value.
SecsDefinedMessage	getResponse() Returns the response message.
SecsMsg	getSecsMsg() Returns the Secs Message.
int	getStream() This will return the stream value.
boolean	processMessage(SecsMsg msg) Process the response to the sent message - if any.
boolean	publishData(SecsMsg msg) Publishes the data from unsolicted messages is they match an incoming message.
SecsMsg	sendMessage() Send the message.

Method Detail

createMessage

SecsMsg createMessage()

Create the message.

Returns:

the raw secs message object

getFunction

int getFunction()

This will return the function value.

getResponse

SecsDefinedMessage getResponse()

Returns the response message.

getSecsMsg

SecsMsg getSecsMsg()

Returns the Secs Message.

getStream

int getStream()

This will return the stream value.

processMessage

boolean processMessage(SecsMsg msg)

Process the response to the sent message - if any. This method should return true if it has handled the message, otherwise false.

publishData

boolean publishData(SecsMsg msg)

Publishes the data from unsolicted messages is they match an incoming message.

sendMessage

SecsMsg sendMessage()
             throws SecsException

Send the message. This will call the subclasses createMessage method and then send the created message through the correct connection.

Returns:

the raw secs message object that was received as the reply. This could be null in the case of T3 or if the messages does not have a reply.

Throws:

SecsException