---

nml_oi.hh

Go to the documentation of this file.

/*********************************************************************
*  File: nml_oi.hh
*
*  Defines Generic NML Message structures used to log errors and interact
*  with an Operator Interface from within an NML_MODULE.
*
**********************************************************************/

/*
   MODIFICATIONS:

   29-May-1997 WPS took definitions from nml_emc.hh
*/

#ifndef NML_OI_HH
#define NML_OI_HH

#include "rcs_defs.hh"          // RCS_EXPORT
#include "cms.hh"               // class CMS
#include "nml.hh"               // class NML
#include "nmlmsg.hh"            // class NMLmsg

// NML operator interface stuff for errors, text, and graphics display

#define NML_ERROR_TYPE    ((NMLTYPE) 1)
#define NML_TEXT_TYPE     ((NMLTYPE) 2)
#define NML_DISPLAY_TYPE  ((NMLTYPE) 3)
#define NML_OPERATOR_REQUEST_TYPE ((NMLTYPE) 4)
#define NML_OPERATOR_REPLY_TYPE ((NMLTYPE) 5)

// Sizes for strings for the above messages

#define NML_ERROR_LEN 256
#define NML_TEXT_LEN 256
#define NML_DISPLAY_LEN 256
#define NML_OPERATOR_REQUEST_LEN 256
#define NML_OPERATOR_REPLY_LEN 256

class RCS_EXPORT NML_ERROR:public NMLmsg
{
public:
  NML_ERROR ():NMLmsg (NML_ERROR_TYPE, sizeof (NML_ERROR))
  {
  };
  ~NML_ERROR ()
  {
  };

  void update (CMS * cms);
  char error[NML_ERROR_LEN];
};

class RCS_EXPORT NML_TEXT:public NMLmsg
{
public:
  NML_TEXT ():NMLmsg (NML_TEXT_TYPE, sizeof (NML_TEXT))
  {
  };
  ~NML_TEXT ()
  {
  };

  void update (CMS * cms);
  char text[NML_TEXT_LEN];
};

class RCS_EXPORT NML_DISPLAY:public NMLmsg
{
public:
  NML_DISPLAY ():NMLmsg (NML_DISPLAY_TYPE, sizeof (NML_DISPLAY))
  {
  };
  ~NML_DISPLAY ()
  {
  };

  void update (CMS * cms);
  char display[NML_DISPLAY_LEN];
};

class RCS_EXPORT NML_OPERATOR_REQUEST:public NMLmsg
{
public:
  NML_OPERATOR_REQUEST ():NMLmsg (NML_OPERATOR_REQUEST_TYPE,
                                  sizeof (NML_OPERATOR_REQUEST))
  {
  };
  ~NML_OPERATOR_REQUEST ()
  {
  };

  void update (CMS * cms);
  int key;
  char request[NML_OPERATOR_REQUEST_LEN];
};

class RCS_EXPORT NML_OPERATOR_REPLY:public NMLmsg
{
public:
  NML_OPERATOR_REPLY ():NMLmsg (NML_OPERATOR_REPLY_TYPE,
                                sizeof (NML_OPERATOR_REPLY))
  {
  };
  ~NML_OPERATOR_REPLY ()
  {
  };

  void update (CMS * cms);
  int key;
  char reply[NML_OPERATOR_REPLY_LEN];
};

// NML format function
extern int RCS_EXPORT nmlErrorFormat (NMLTYPE type, void *buffer, CMS * cms);


#endif

---