MPSPortal

```
public interface MPSPortal
```
MPSPortal is the interface to remote clients

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CHANNEL_CONNECTED_KEY` Description of the Field
`static java.lang.String`	`CHANNEL_PV_KEY` Description of the Field
`static java.lang.String`	`DATE_FORMAT` Date format for passing dates as strings
`static int`	`EVENT_ID_COUNT` count of the event IDs
`static int`	`INPUT_CHANNEL_EVENT_ID` key used in the event time table to indicate an MPS channel event
`static int`	`MPS_CHANNEL_EVENT_ID` key used in the event time table to indicate an MPS channel event
`static int`	`MPS_EVENT_BUFFER_SIZE` size of the MPS event buffer
`static int`	`MPS_EVENT_ID` key used in the event time table to indicate an MPS event
`static java.lang.String`	`SIGNAL_EVENTS_KEY` key used in the event time table to indicate signal events
`static java.lang.String`	`TIMESTAMP_KEY` key used in the latest MPS event table

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getFirstHitText(int monitorIndex)` Get the summary of first hit statistics
`java.lang.String`	`getHostName()` Get the name of the host where the application is running.
`java.util.List<java.util.Map<java.lang.String,java.lang.Object>>`	`getInputChannelInfo(int monitorIndex)` Get the list of all Input PVs we are attempting to monitor and log.
`java.util.Date[]`	`getLastEventTimes(int monitorIndex)` Get an arry of timestamps corresponding to the different event ids.
`java.util.List<java.util.Map<java.lang.String,java.lang.Object>>`	`getLatestMPSEvents(int monitorIndex)` Get the list of latest MPS events
`java.util.Date`	`getLaunchTime()` Get the launch time of the service.
`java.util.List<java.util.Map<java.lang.String,java.lang.Object>>`	`getMPSChannelInfo(int monitorIndex)` Get the list of all MPS PVs we are attempting to monitor and log.
`java.util.List<java.util.Map<java.lang.String,java.lang.Object>>`	`getMPSEventsSince(int monitorIndex, java.lang.String timeStr)` Get the list of MPS events since the specified time
`java.lang.String`	`getMPSTripSummary(int monitorIndex)` Get the summary of MPS trips.
`java.util.List<java.lang.String>`	`getMPSTypes()` Get the list of MPS latch types.
`int`	`getProcessID()` Get the process ID of the process in which the service runs or 0 if it is unknown
`boolean`	`isRunning(int monitorIndex)` Determing if the correlator is running.
`boolean`	`logsStatistics()` determine whether the monitors log statistics
`void`	`reloadSignals(int monitorIndex)` Reload the MPS signals from the signal data source for the specified monitor.
`void`	`restartCorrelator(int monitorIndex)` Restart the poster after a pause
`void`	`shutdown(int code)` Shutdown the process.
`void`	`stopCorrelator(int monitorIndex)` Stop looking for MPS trips

- Field Detail
  - DATE_FORMAT
```
static final java.lang.String DATE_FORMAT
```
    Date format for passing dates as strings
    
    See Also:
    
    Constant Field Values
  - MPS_EVENT_BUFFER_SIZE
```
static final int MPS_EVENT_BUFFER_SIZE
```
    size of the MPS event buffer
    
    See Also:
    
    Constant Field Values
  - CHANNEL_PV_KEY
```
static final java.lang.String CHANNEL_PV_KEY
```
    Description of the Field
    
    See Also:
    
    Constant Field Values
  - CHANNEL_CONNECTED_KEY
```
static final java.lang.String CHANNEL_CONNECTED_KEY
```
    Description of the Field
    
    See Also:
    
    Constant Field Values
  - TIMESTAMP_KEY
```
static final java.lang.String TIMESTAMP_KEY
```
    key used in the latest MPS event table
    
    See Also:
    
    Constant Field Values
  - SIGNAL_EVENTS_KEY
```
static final java.lang.String SIGNAL_EVENTS_KEY
```
    key used in the event time table to indicate signal events
    
    See Also:
    
    Constant Field Values
  - MPS_CHANNEL_EVENT_ID
```
static final int MPS_CHANNEL_EVENT_ID
```
    key used in the event time table to indicate an MPS channel event
    
    See Also:
    
    Constant Field Values
  - INPUT_CHANNEL_EVENT_ID
```
static final int INPUT_CHANNEL_EVENT_ID
```
    key used in the event time table to indicate an MPS channel event
    
    See Also:
    
    Constant Field Values
  - MPS_EVENT_ID
```
static final int MPS_EVENT_ID
```
    key used in the event time table to indicate an MPS event
    
    See Also:
    
    Constant Field Values
  - EVENT_ID_COUNT
```
static final int EVENT_ID_COUNT
```
    count of the event IDs
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getProcessID
```
int getProcessID()
```
    Get the process ID of the process in which the service runs or 0 if it is unknown
  - shutdown
```
void shutdown(int code)
```
    Shutdown the process.
    
    Parameters:
    
    code - The shutdown code which is normally just 0.
  - getHostName
```
java.lang.String getHostName()
```
    Get the name of the host where the application is running.
    
    Returns:
    
    The name of the host where the application is running.
  - getLaunchTime
```
java.util.Date getLaunchTime()
```
    Get the launch time of the service.
    
    Returns:
    
    the launch time in seconds since the Java epoch of January 1, 1970.
  - logsStatistics
```
boolean logsStatistics()
```
    determine whether the monitors log statistics
  - getMPSTypes
```
java.util.List<java.lang.String> getMPSTypes()
```
    Get the list of MPS latch types. Monitors are listed as an array and their index in this array can be used in several methods to reference a specific monitor.
    
    Returns:
    
    the list of MPS latch types as strings (e.g. "FPL", "FPAR")
  - isRunning
```
boolean isRunning(int monitorIndex)
```
    Determing if the correlator is running.
    
    Parameters:
    
    monitorIndex - index of the monitor to test if its correlator is running
    
    Returns:
    
    true if the correlator is running and false otherwise.
  - stopCorrelator
```
void stopCorrelator(int monitorIndex)
```
    Stop looking for MPS trips
    
    Parameters:
    
    monitorIndex - index of the monitor that should stop its correlator
  - restartCorrelator
```
void restartCorrelator(int monitorIndex)
```
    Restart the poster after a pause
    
    Parameters:
    
    monitorIndex - index of the monitor that should restart its correlator
  - reloadSignals
```
void reloadSignals(int monitorIndex)
```
    Reload the MPS signals from the signal data source for the specified monitor.
    
    Parameters:
    
    monitorIndex - index of the monitor that should reload its signals
  - getLastEventTimes
```
java.util.Date[] getLastEventTimes(int monitorIndex)
```
    Get an arry of timestamps corresponding to the different event ids. The values are Date objects that indicate the time the last event of the specified type had happened. This method may be used by clients to determine if their information is current.
    
    Parameters:
    
    monitorIndex - index of the monitor whose timestamps are requested
    
    Returns:
    
    an array of timestamps
  - getMPSChannelInfo
```
java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getMPSChannelInfo(int monitorIndex)
```
    Get the list of all MPS PVs we are attempting to monitor and log. The information is returned as a list of channel info tables (one entry for each PV). The channel info table has the CHANNEL_PV_KEY and CHANNEL_CONNECTED_KEY keys and provides the signal name and the connection status of a channel.
    
    Parameters:
    
    monitorIndex - index of the monitor whose channel info is requested
    
    Returns:
    
    The list of all MPS PV info tables for the PVs we are attempting to monitor and log
  - getInputChannelInfo
```
java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getInputChannelInfo(int monitorIndex)
```
    Get the list of all Input PVs we are attempting to monitor and log. The information is returned as a list of channel info tables (one entry for each PV). The channel info table has the CHANNEL_PV_KEY and CHANNEL_CONNECTED_KEY keys and provides the signal name and the connection status of a channel.
    
    Parameters:
    
    monitorIndex - index of the monitor whose channel info is requested
    
    Returns:
    
    The list of all PV info tables for the Input PVs we are attempting to monitor and log
  - getFirstHitText
```
java.lang.String getFirstHitText(int monitorIndex)
```
    Get the summary of first hit statistics
    
    Parameters:
    
    monitorIndex - index of the monitor whose statistics are to be fetched
    
    Returns:
    
    the first hit statistics summary
  - getMPSTripSummary
```
java.lang.String getMPSTripSummary(int monitorIndex)
```
    Get the summary of MPS trips.
    
    Parameters:
    
    monitorIndex - index of the monitor whose statistics are to be fetched
    
    Returns:
    
    summary of MPS trips
  - getMPSEventsSince
```
java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getMPSEventsSince(int monitorIndex,
                                                                                   java.lang.String timeStr)
```
    Get the list of MPS events since the specified time
    
    Parameters:
    
    monitorIndex - index of the monitor whose statistics are to be fetched
    
    timeStr - a string representation of the reference time
    
    Returns:
    
    the latest processed MPS events since the specified time
  - getLatestMPSEvents
```
java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getLatestMPSEvents(int monitorIndex)
```
    Get the list of latest MPS events
    
    Parameters:
    
    monitorIndex - index of the monitor whose statistics are to be fetched
    
    Returns:
    
    the latest ordered list of MPS events

Interface MPSPortal

Field Summary

Method Summary

Field Detail

DATE_FORMAT

MPS_EVENT_BUFFER_SIZE

CHANNEL_PV_KEY

CHANNEL_CONNECTED_KEY

TIMESTAMP_KEY

SIGNAL_EVENTS_KEY

MPS_CHANNEL_EVENT_ID

INPUT_CHANNEL_EVENT_ID

MPS_EVENT_ID

EVENT_ID_COUNT

Method Detail

getProcessID

shutdown

getHostName

getLaunchTime

logsStatistics

getMPSTypes

isRunning

stopCorrelator

restartCorrelator

reloadSignals

getLastEventTimes

getMPSChannelInfo

getInputChannelInfo

getFirstHitText

getMPSTripSummary

getMPSEventsSince

getLatestMPSEvents