REGISTRY

From ICE Enterprises
Jump to navigation Jump to search

Displays and manipulates registry entries.

<FUNC> - What to do (SHOW, COPY, START, STOP)
<P1>   - <FUNC>-dependent parameter
<P2>   - <FUNC>-dependent parameter

The registry shows a list of the commands that are running. In general this
includes any macros or primitives run in the background or in a pipe. The
registry table has three special entries:
      SHELL    - Pointer to the current shell.
      HANDLERS - The handlers table (includes file handlers).
      MAIN     - Pointer to the current macro (only available inside a macro).

Of all of the functions available, SHOW is the most common and is almost
universally run with no arguments (i.e. listing all entries in the registry):
        nM> reg
          T: REG             = Table of 4 entries
          O:  PLOT           = P: PLOT,FILE=,/BG=
          O:  SHELL          = nxm.sys.lib.Shell@c1cd1f
          O:  SD360          = M: SD360,SAMPLES=5E6,FORMAT=SF,/SERVER=,/BG=
          T:  HANDLERS       = Table of 3 entries


Functions:
  SHOW  - Shows an entry in the registry. For the SHOW function, <P1> is the
          registry entry label. If <P1> is blank then all entries are shown. If
          <P1> indicates a macro, the macro's registry is shown.

  COPY  - Copies entries. For the COPY function, <P1> is the source registry
          entry label and <P2> is the label of the destination registry entry.

  FINISH - This function sets the Command state to FINISH and waits 
          up to timeout seconds for the Command to reach the DONE status.  
          <P1> is the name in the registry and <P2> is the timeout in seconds.

  ABORT - This function sets the Command state to ABORT and waits 
          up to timeout seconds for the Command to reach the DONE status.  
          <P1> is the name in the registry and <P2> is the timeout in seconds.

  WAIT  - This function waits for the Command to enter the PROCESS state.
          <P1> is the name in the registry and <P2> is the timeout in seconds.

  STOP  - The STOP function stops the Command and waits for its close() to
          complete.  The command stays resident but is inactive. 
          <P1> is the name in the registry and <P2> is the timeout in seconds.

  START - The START function restarts the Command and waits for its open() to
          complete.  The command must be resident after a previous STOP.
          <P1> is the name in the registry and <P2> is the timeout in seconds.

Examples:
  1. List all entries in the registry.
        nM> reg
          T: REG             = Table of 4 entries
          O:  PLOT           = P: PLOT,FILE=,/BG=
          O:  SHELL          = nxm.sys.lib.Shell@c1cd1f
          O:  SD360          = M: SD360,SAMPLES=5E6,FORMAT=SF,/SERVER=,/BG=
          T:  HANDLERS       = Table of 3 entries

  2. Display an individual primitive in the registry. (This did not work
     correctly prior to NeXtMidas 2.3.0.)
        nM> reg show plot
          O: REG.PLOT        = P: PLOT,FILE=,/BG=

  3. Display an individual macro in the registry.
        nM> reg show sd360
          O: MAIN            = M: SD360...
          O: PANEL           = P: PANEL...
          T: WIN             = Table of 3 entries
          O:  PANE0          = Pane PANE0 x=0 y=0 w=0 h=0
          O:  PLOT1          = Pane PLOT1 x=183 y=18 w=448 h=211
          O:  PLOT2          = Pane PLOT2 x=183 y=253 w=448 h=331
          O: WAVEFORM        = P: WAVEFORM...
          O: FFT             = P: FFT...
          O: RMIF            = P: RMIF...
          O: PLOT1           = P: PLOT...
          O: PLOT2           = P: PLOT...

Switches:
  /ALL - For SHOW function, expand table results.
  /TIMEOUT - alternate timeout in seconds