FourMSControllerInterfaces
Class SubActionCompletionListenerImpl

java.lang.Object
  org.omg.PortableServer.Servant
      FourMSControllerInterfaces.SubActionCompletionListenerPOA
          FourMSControllerInterfaces.SubActionCompletionListenerImpl

All Implemented Interfaces:

SubActionCompletionListenerOperations, org.omg.CORBA.portable.InvokeHandler

public class SubActionCompletionListenerImpl
extends SubActionCompletionListenerPOA

This is a CORBA object which will be called when a subaction completes for whatever reason. Note the location of this class, this class needs to be located in this directory for resolution by the java compiler as the class is intrinsically tied up with the java files which are generated as a result of compiling the IDL files. This class implements the Subaction completion interface and will be used by any object that will invoke methods on a 4MS controller.

Author:

Craige Bevil

Field Summary

int	CmdError This is the command error associated with any failure
java.lang.String	CmdErrorStr This is the string associated with the command error
java.lang.String	InstrumentName This is the name of the instrument which was associated with the action that has completed
java.lang.String	MechanismName This is the name of the mechanism which was associated with the action that has completed
int	MechError This is mechanism error if there was one
java.lang.String	MechErrorStr This is a string which is textual representation of the mechanism error
java.lang.String	Reason This is the reason for any failure of the subaction
int	ReasonCode This is the reason code assocaited with the value that was returned
java.lang.String	Severity This is the severity of any error
java.lang.String	SubactionName This is the name of the subaction that completed
(package private) SubActionCompletionListenerOperations	SubactionResultListener This object will be informed when there is a change in the final state of the subaction
boolean	SubactionTerminated Set when the subaction has completed
private MessageHandler	SyslogMessageHandler This is a syslog object which will be used to report errors etc
boolean	WaitForSubactionToComplete This flag indicates that when a subaction is started by this subaction, we should wait until that subaction has completed before continuing

Constructor Summary

SubActionCompletionListenerImpl(SubActionCompletionListenerOperations SubactionResultListener, MessageHandler SyslogMessageHandler)

Method Summary

void	subActionEnded(java.lang.String SubactionName, java.lang.String MechanismName, java.lang.String InstrumentName, int ReasonCode, java.lang.String Reason, int CmdError, java.lang.String CmdErrorStr, int MechError, java.lang.String Severity, java.lang.String MechErrorStr) This is a callback method which will be called when a subaction has completed for whatever reason.
void	waitForSubactionTermination() This method will be stop the existing thread until the subaction which is in progress has completed

Methods inherited from class FourMSControllerInterfaces.SubActionCompletionListenerPOA

_all_interfaces, _invoke, _this, _this

Methods inherited from class org.omg.PortableServer.Servant

_default_POA, _get_delegate, _get_interface_def, _is_a, _non_existent, _object_id, _orb, _poa, _set_delegate, _this_object, _this_object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SyslogMessageHandler

private MessageHandler SyslogMessageHandler

This is a syslog object which will be used to report errors etc

SubactionName

public java.lang.String SubactionName

This is the name of the subaction that completed

MechanismName

public java.lang.String MechanismName

This is the name of the mechanism which was associated with the action that has completed

InstrumentName

public java.lang.String InstrumentName

This is the name of the instrument which was associated with the action that has completed

ReasonCode

public int ReasonCode

This is the reason code assocaited with the value that was returned

Reason

public java.lang.String Reason

This is the reason for any failure of the subaction

CmdError

public int CmdError

This is the command error associated with any failure

CmdErrorStr

public java.lang.String CmdErrorStr

This is the string associated with the command error

MechError

public int MechError

This is mechanism error if there was one

MechErrorStr

public java.lang.String MechErrorStr

This is a string which is textual representation of the mechanism error

Severity

public java.lang.String Severity

This is the severity of any error

SubactionTerminated

public boolean SubactionTerminated

Set when the subaction has completed

WaitForSubactionToComplete

public boolean WaitForSubactionToComplete

This flag indicates that when a subaction is started by this subaction, we should wait until that subaction has completed before continuing

SubactionResultListener

SubActionCompletionListenerOperations SubactionResultListener

This object will be informed when there is a change in the final state of the subaction

Constructor Detail

SubActionCompletionListenerImpl

public SubActionCompletionListenerImpl(SubActionCompletionListenerOperations SubactionResultListener,
                                       MessageHandler SyslogMessageHandler)

Method Detail

waitForSubactionTermination

public void waitForSubactionTermination()

This method will be stop the existing thread until the subaction which is in progress has completed

subActionEnded

public void subActionEnded(java.lang.String SubactionName,
                           java.lang.String MechanismName,
                           java.lang.String InstrumentName,
                           int ReasonCode,
                           java.lang.String Reason,
                           int CmdError,
                           java.lang.String CmdErrorStr,
                           int MechError,
                           java.lang.String Severity,
                           java.lang.String MechErrorStr)

This is a callback method which will be called when a subaction has completed for whatever reason.