gov.nasa.gsfc.drl.rtstps.server
Interface RtStpsServices

All Superinterfaces:
java.rmi.Remote
All Known Implementing Classes:
AbstractServer, TcpServer, UdpServer

public interface RtStpsServices
extends java.rmi.Remote

This interface defines the methods a client like the viewer must use to talk to the server.


Method Summary
 java.lang.String getConfigurationName()
          Get the name of the currently loaded configuration.
 StatusBlock[] getStatus()
          Get the current status from the last-used pipeline.
 java.lang.String[] getStatusToString()
          Precompute the status strings from the StatusBlocks
 boolean isEnabled()
          Is the server loaded and enabled?
 void load(char[] configuration)
          Load a configuration.
 void load(java.lang.String configuration)
          Load a configuration.
 void loadFile(java.lang.String file)
          Load a configuration from a file that is local to the server.
 void setEnabled(boolean enable)
          Enable or disable RLP data processing.
 void stopServer()
          Stop the RT-STPS server.
 void unload()
          Unload a configuration, which closes all open data files.
 void zeroStatus()
          Set all clearable status counters to zero.
 

Method Detail

zeroStatus

void zeroStatus()
                throws java.rmi.RemoteException
Set all clearable status counters to zero.

Throws:
java.rmi.RemoteException

getStatus

StatusBlock[] getStatus()
                        throws java.rmi.RemoteException
Get the current status from the last-used pipeline. Within a session, the number and identity of the status blocks and the number and identity of the contained status items will not change. Only the status item values may change. However, when a session changes and a new configuration is loaded, then all of these elements will change.

Returns:
If no configuration has been loaded into the server, then this method returns null. Otherwise it returns the status of the last created pipeline, even post-session.
Throws:
java.rmi.RemoteException

getStatusToString

java.lang.String[] getStatusToString()
                                     throws java.rmi.RemoteException
Precompute the status strings from the StatusBlocks

Throws:
java.rmi.RemoteException

load

void load(java.lang.String configuration)
          throws java.rmi.RemoteException
Load a configuration.

Throws:
java.rmi.RemoteException

load

void load(char[] configuration)
          throws java.rmi.RemoteException
Load a configuration.

Throws:
java.rmi.RemoteException

loadFile

void loadFile(java.lang.String file)
              throws java.rmi.RemoteException
Load a configuration from a file that is local to the server.

Throws:
java.rmi.RemoteException

setEnabled

void setEnabled(boolean enable)
                throws java.rmi.RemoteException
Enable or disable RLP data processing. This action does not reset the board or change the configuration.

Throws:
java.rmi.RemoteException

unload

void unload()
            throws java.rmi.RemoteException
Unload a configuration, which closes all open data files.

Throws:
java.rmi.RemoteException

getConfigurationName

java.lang.String getConfigurationName()
                                      throws java.rmi.RemoteException
Get the name of the currently loaded configuration.

Returns:
null if none is loaded.
Throws:
java.rmi.RemoteException

isEnabled

boolean isEnabled()
                  throws java.rmi.RemoteException
Is the server loaded and enabled?

Throws:
java.rmi.RemoteException

stopServer

void stopServer()
                throws java.rmi.RemoteException
Stop the RT-STPS server.

Throws:
java.rmi.RemoteException