RAMSES	Systems Ecology
Start         Modules:   A-Z   Function   Layer        QuickRefs:   DM   AuxLib   AuxLibE   SciLib   EasyMW   MW   ISIS   RMSLib

DEFINITION MODULE Protocolling;

  (*******************************************************************

    Module  Protocolling     (Version 1.0)

      Copyright (c) 1990-2006 by Andreas Fischlin and ETH Zurich.

    Purpose   Protocolling of current activity in a separate
              protocol window.

    Remarks   May be used by any program which executes lengthy
              and complicated operations to report current state
              and current activities to the user.

              Current implementation restriction:  Since protocol
              header and termination messages are application
              dependent, this module has to be adapted if used
              by another client.


    Programming

      o Design
        Andreas Fischlin          03/09/1990

      o Implementation
        Andreas Fischlin          03/09/1990


    ETH Zurich
    Systems Ecology
    CHN E 35.1
    Universitaetstrasse 16
    8092 Zurich
    SWITZERLAND

    URLs:
        <mailto:RAMSES@env.ethz.ch>
        <http://www.sysecol.ethz.ch>
        <http://www.sysecol.ethz.ch/SimSoftware/RAMSES>


    Last revision of definition:  03/09/1990  AF

  *******************************************************************)


  CONST
    dispProgressAtLn = 9; dispProgressAtCol = 2;
    (* default position to display a progress in form of a number *)

  PROCEDURE ActivateProtocolWindow; (* opens it or puts it on front *)
  PROCEDURE StartProtocol; (* writes header message *)
  PROCEDURE EraseProtocol; (* erases all *)
  PROCEDURE ReportString (s: ARRAY OF CHAR);
  PROCEDURE ReportLine (s: ARRAY OF CHAR);
  PROCEDURE ReportIntAt (inRow,atCol, i, le: INTEGER); (* write i at position [inRow,atCol] *)
  PROCEDURE TerminateProtocol;  (* writes termination message *)

END Protocolling.