---

nml_mod2.hh

Go to the documentation of this file.

#ifndef NML_MODULE_H
#define NML_MODULE_H

/*
   nml_mod.h

   Declarations of NML class derived from RCS_MODULE_C, which include
   NML channels and an RCS_TIMER.
   */

/*
   Modification history:

    3-Apr-1997 WPS made NML_MODULE no longer the subordinate of RCS_MODULE_C
    and brought those functions, variables from RCS_MODULE_C we want in
    here directly.
    7-Mar-1997 WPS changed header files to 8.3 format.
   11-Feb-1997 WPS modified --  calc_avg_time, update_line_history, and
   stop_timing all use exec_history but fail to check to
   see if it is initialized.
   I override them here minimize changes to rcs_module.cc
   3-Dec-1996  FMP changed NML to RCS_CMD/STAT_CHANNEL for commandIn,
   statusOut, etc.
   112696  hui, changed the base class for commandInData, etc., from NMLmsg
   to RCS_CMD_MSG and RCS_STAT_MSG.
   29-Jul-1996  FMP moved NML_ERROR, NML_TEXT, NML_DISPLAY, and NML_STATUS
   into nml_emc.hh
   29-Jul-1996  FMP added NML_TEXT and NML_DISPLAY classes; added member
   functions for logText and requestDisplay
   10-Jun-1996  Fred Proctor added commandOutstanding, commandLastNum arrays;
   NML_STATUS struct
   5-Jun-1996  Fred Proctor added errorLog, logError()
   29-Apr-1996  Fred Proctor moved 'done' from RCS_MODULE_C to here.
   16-Apr-1996  Fred Proctor added NMLmsg *'s
   5-Apr-1996  Fred Proctor created
    */

#include "rcs_mod.h"
#include "rcs.hh"

class NML_MODULE2
{
public:
  // This section taken from RCS_MODULE_C
  void controller (void);

  virtual void DECISION_PROCESS (void);

  virtual void READ_COMM_BUFFERS (void);        // Preprocess
  virtual void LOAD_LOCAL_VARIABLES (void);
  virtual void READ_CHILD_BUFFERS (void);
  virtual void DETERMINE_CHILDREN_STATUS (void);
  virtual void PRE_PROCESS_PARAMETERS (void);

  virtual void POST_PROCESS_PARAMETERS (void);  // Postprocess
  virtual void UNLOAD_LOCAL_VARIABLES (void);
  virtual void WRITE_COMM_BUFFERS (void);
  virtual void WRITE_CHILD_BUFFERS (void);

  // State table functions
  int stateMatch (char *_src_file, int source_line, int state, int conds = 1);
  int stateMatch (int state, int conds = 1);
  void stateNext (int state);

protected:

  void pre_process (void);      // preprocess
  void check_if_new_command (void);
  void check_if_new_sup_request (void);
  void start_timing (void);
  void check_run_command (void);
  void check_cycle_time (void);

  void post_process (void);     // postprocess
  void calc_avg_time (void);
  void update_line_num_history (void);

  void stop_timing (void);


  RCS_EXEC_HISTORY_STRUCT exec_history; // Exec History
  RCS_EXEC_STATUS_STRUCT exec_status;

  RCS_RUN_COMMAND_STRUCT run_command;   // Run Command
  RCS_RUN_STATUS_STRUCT run_status;


  long cycle_start;             // Data
  long cycle_stop;

  int command_time_averaged;
  int new_command_sequence;
  int new_line_num_sequence;
  int new_sup_request;

  long delta_clock;
  long cycle_time;
  long command_current_time;

  int pause_status;
  int command;
  int last_line;

  int execute;
  int command_time;
  int state;
  int status;

  int sup_req_num;
  int sup_req_num_echo;
  int command_num;
  int command_num_echo;

private:
  int matched;                  /* flag set when a state is matched, to
                                   prevent fall-through to another state */
  int stateBegin;               /* flag set by controller() signifying
                                   that stateMatch should init line number */

public:

    NML_MODULE ();
   ~NML_MODULE ();

  RCS_CMD_CHANNEL *commandIn;   // NML channel for command from supervisor
  RCS_STAT_CHANNEL *statusOut;  // NML channel for status to supervisor
  RCS_CMD_CHANNEL **commandOut; // NML channels for commands to subordinates
  RCS_STAT_CHANNEL **statusIn;  // NML channels for status from subordinates
  NML *errorLog;                // NML channel for logging errors

  RCS_CMD_MSG *commandInData;   // ptr to NML data in channel
  RCS_STAT_MSG *statusOutData;  // ptr to NML data to be put in channel
  RCS_CMD_MSG **commandOutData; // ptrs to NML data to be put in channel
  RCS_STAT_MSG **statusInData;  // ptrs to NML data in channels

  int *commandLastNum;          // array of command nums saved before writes
  int *commandOutstanding;      // array of flags, 1 = command has been sent,
  // 0 = command has finished

  RCS_TIMER *timer;             // synch timer

  int done;                     // non-zero means stop calling controller()

  int setSubordinates (int number);
  int logError (const char *fmt, ...);
  int logText (const char *fmt, ...);
  int requestDisplay (const char *display);

  // WPS modified 11-Feb-1997 calc_avg_time, update_line_history, and
  // stop_timing all use exec_history but fail to check to
  // see if it is initialized.
  // I override them here minimize changes to rcs_module.cc
  void calc_avg_time (void);
  void update_line_num_history (void);

  void stop_timing (void);

protected:

  int numSubordinates;          // number of subordinates for this module
};

#endif

---