---

nml_mod.cc

Go to the documentation of this file.

/*
   nml_module.cc

   Definition of NML_MODULE class.
   */

/*
   Modification history:

   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.
   16-Oct-1996  FMP inited done to 0 in ctor
   29-Jul-1996  FMP moved NML_ERROR, NML_TEXT, NML_DISPLAY, and NML_STATUS
   into nml_emc.cc
   29-Jul-1996  FMP added NML_TEXT and NML_DISPLAY classes
   10-Jun-1996  Fred Proctor added malloc/free of cmdOutstanding array
   5-Jun-1996  Fred Proctor added NML error stuff
   16-Apr-1996  Fred Proctor added NMLmsg * initing
   5-Apr-1996  Fred Proctor created
    */

extern "C"
{
#include <stdlib.h>             // malloc()
#include <string.h>             // strcpy()
#include <stdarg.h>
}

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

NML_MODULE::NML_MODULE ()
{
  commandIn = 0;
  commandInData = 0;
  statusOut = 0;
  statusOutData = 0;
  commandOut = 0;
  commandOutData = 0;
  statusIn = 0;
  statusInData = 0;
  commandLastNum = 0;
  commandOutstanding = 0;
  timer = 0;
  numSubordinates = 0;
  errorLog = 0;
  done = 0;
}

NML_MODULE::~NML_MODULE ()
{
  int t;

  if (commandIn != 0)
    delete commandIn;
  commandIn = 0;

  if (statusOut != 0)
    delete statusOut;
  statusOut = 0;

  if (errorLog != 0)
    delete (errorLog);
  errorLog = 0;

  if (commandOut != 0)
    {
      for (t = 0; t < numSubordinates; t++)
        {
          if (commandOut[t] != 0)
            delete commandOut[t];
        }

      free (commandOut);
      commandOut = 0;
    }

  if (commandInData != 0)
    {
      free (commandOutData);
      commandOutData = 0;
    }

  if (statusIn != 0)
    {
      for (t = 0; t < numSubordinates; t++)
        {
          if (statusIn[t] != 0)
            delete statusIn[t];
        }

      free (statusIn);
      statusIn = 0;
    }

  if (statusInData != 0)
    {
      free (statusInData);
      statusInData = 0;
    }

  if (commandOutstanding != 0)
    {
      free (commandOutstanding);
      commandOutstanding = 0;
    }

  if (commandLastNum != 0)
    {
      free (commandLastNum);
      commandLastNum = 0;
    }

  if (timer != 0)
    delete timer;
  timer = 0;
}

int
NML_MODULE::setSubordinates (int number)
{
  int t;

  if (number < 0)
    return -1;

  // record number of subordinates
  numSubordinates = number;

  // get out now if nothing else to do
  if (number == 0)
    return 0;

  // allocate subordinate NML channels
  commandOut =
    (RCS_CMD_CHANNEL **) malloc (number * sizeof (RCS_CMD_CHANNEL *));
  commandOutData = (RCS_CMD_MSG **) malloc (number * sizeof (RCS_CMD_MSG *));
  statusIn =
    (RCS_STAT_CHANNEL **) malloc (number * sizeof (RCS_STAT_CHANNEL *));
  statusInData = (RCS_STAT_MSG **) malloc (number * sizeof (RCS_STAT_MSG *));

  // allocate commandOutstanding array
  commandLastNum = (int *) malloc (number * sizeof (int));
  commandOutstanding = (int *) malloc (number * sizeof (int));

  // initialize each NML channel in the new arrays to 0
  for (t = 0; t < number; t++)
    {
      commandOut[t] = 0;
      commandOutData[t] = 0;
      statusIn[t] = 0;
      statusInData[t] = 0;

      commandOutstanding[t] = 0;
    }

  return 0;
}

/*
   Error, text, and display functions. Note that all these go to
   the errorLog channel
   */

int
NML_MODULE::logError (const char *fmt, ...)
{
  NML_ERROR error_msg;
  va_list ap;

  // check channel for validity
  if (errorLog == NULL)
    return -1;
  if (!errorLog->valid ())
    return -1;

  // write args to NML message
  va_start (ap, fmt);
  vsprintf (error_msg.error, fmt, ap);
  va_end (ap);

  // force a NULL at the end for safety
  error_msg.error[NML_ERROR_LEN - 1] = 0;

  // write it
  errorLog->write (error_msg);

  return 0;
}

int
NML_MODULE::logText (const char *fmt, ...)
{
  NML_TEXT text_msg;
  va_list ap;

  // check channel for validity
  if (errorLog == NULL)
    return -1;
  if (!errorLog->valid ())
    return -1;

  // write args to NML message
  va_start (ap, fmt);
  vsprintf (text_msg.text, fmt, ap);
  va_end (ap);

  // force a NULL at the end for safety
  text_msg.text[NML_TEXT_LEN - 1] = 0;

  // write it
  errorLog->write (text_msg);

  return 0;
}

int
NML_MODULE::requestDisplay (const char *display)
{
  NML_DISPLAY display_msg;

  // check channel for validity
  if (errorLog == NULL)
    return -1;
  if (!errorLog->valid ())
    return -1;

  // write args to NML message
  strcpy (display_msg.display, display);

  // force a NULL at the end for safety
  display_msg.display[NML_DISPLAY_LEN - 1] = 0;

  // write it
  errorLog->write (display_msg);

  return 0;
}


  // 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
NML_MODULE::calc_avg_time (void)
{
  if (NULL == exec_history)
    {
      return;
    }
  RCS_MODULE_C::calc_avg_time ();
}


void
NML_MODULE::update_line_num_history (void)
{
  if (NULL == exec_history)
    {
      return;
    }
  RCS_MODULE_C::update_line_num_history ();
}

void
NML_MODULE::stop_timing (void)
{
  if (NULL == exec_history)
    {
      return;
    }
  RCS_MODULE_C::update_line_num_history ();
}

---