Package FourMS

Interface Summary
i4MSMessageListenerInterface This interface provides a means through which the controller message dispatcher can send back the details of messages that come back from the 4MS controller to be processed.
i4MSMessageSender This is the interface that must be implemented by each class which is expected to send a message using the 4MS message handler object.
iActionFinishedListenerInterface This class describes a interface which should be implemented by any class which initiates a subaction upon a mechanism.
iControllerDispatchListenerInterface Will be used by an object which is expecting to be informed by a 4MS controller dispatch object of a message that is to be dispatched.
iDispatchMessageInterface This interface outlines the methods which are required by a class which will be responsible dispatching 4MS messages.
iRawParameterTransformation This is the interface that must be implemented by each instrument controller task which is expecting to transform the raw unconverted items which come from the status responses from a 4MS.
 

Class Summary
ER412MessageComponent This class solely contains data which describes the components that consitute a single ER412 message .i.e.
FilterDetails This is a container class to hold the details of the filters associated with an instrument
FourMSCommsMonitor This class will monitor the time of the last communications from the 4MS module and should no comms be received from the module in the allocated time, the class will bring this to the attention of the system by creating an entry in the syslog and also setting a noticeboard item.
FourMSConstants This is a class full of constants which are used throughout the 4MS package.
FourMSController This class describes the main 4MS class which will be used to control a 4MS microprocessor.
FourMSControllerMessageDispatcher This class will be responsible for dispatching any incoming messages from the 4MS and send them to the mechanisms to be processed.
FourMSConversions This class will be used to hold the standard conversion methods which will be used to convert parameters coming to and from the 4MS microprocessor.
FourMSMessage This a container class which is used for passing the details of message coming back from the 4MS or 4MS simulation.
FourMSMessageHandler This class will form the lowest level interface to the 4MS controller and will access the port server device drivers in order to do so.
FourMSParameterConverter This class contains the methods necessary to perform conversion for the parameters associated with different mechanisms and message types between engineering and logical units.
Mechanism This class models a mechanism in a 4MS.
MechanismBase This class forms the base class for all mechanism type classes in the 4MS software control system.
MessageDispatcher This class is a base class for the message dispatcher subclasses.
MessageListener This class is a threaded class which will be used to monitor the input port which will be responsible for piping into an application data that is coming from an input stream from for example, a 4MS simulator or from the 4MS itself.
MessagePoster Describes a single message which is sent from software/simulator controller and includes methods which will be used to verify the correct acknowledgments are received, timeouts are executed and retries are made.
OpticalComponent This is a container class to hold the details of the optical components in mechanisms which are associated with an instrument
SequenceSubaction This is a base class which will be used by the instrument controller tasks to create compound high level, sequence actions.
SubAction This class describes a dialogue which may take place between the 4MS and a client.
UpdateOpticalComponentList This is an subaction which can be used to update the noticeboard items which hold the details of the optical components for each of the mechanisms which can hold optical components which are located in a specified instrument controller system.
 

Enum Summary
OpticalComponentType Represents the different optical component types which are available in the world of the ING
 

Exception Summary
ConversionAlreadyRegisteredException This exception is raised when an object attempts to register more than one 4MS input/output conversion on a specified parameter in a 4MS message.
ConversionFailedException If the conversion for the parameter specified fails then the ConversionFailedException is raised.
InstrumentNotFoundException This is an exception that is raised when an attempt to look up the details of an instrument in the 4MS database but the instrument that was specified does not exist.
Malformed4MSMessageException Thrown in the case that a malformed 4MS message is received
MechanismUnknownException This is raised when a subaction is referred to which does not exist,
MessageTypeNotFoundException This is raised when a subaction is referred to which does not exist,
SubActionUnknownException This is raised when a subaction is referred to which does not exist,
UnableToCommunicateWith4MSException An exception which is raised when it is not possible to communicate withe 4MS via the port server.
UnableToConstruct4MSMessageException Thrown when unable to construct a 4MS message as the number or type of input parameters are inadequate