mi32/rvcparms.h

Go to the documentation of this file.

/**
 * \file rvcparms.h <mi32/rvcparms.h>
 * \brief 
 *
 * Functions for saving/loading structures in the style of dispwsl.c, but
 * much simpler.  Currently used for OTYPE_DBPARM.  Objects of this type are
 * based on OTYPE_TEXT with no changes to the structure.
 *
 * \if NODOC
 * $Id: rvcparms.h_v 1.17 2003/10/15 17:39:23 mju Exp $
 *
 * $Log: rvcparms.h_v $
 * Revision 1.17  2003/10/15 17:39:23  mju
 * Deprecate groupkey.
 *
 * Revision 1.16  2003/09/15 13:49:56  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.15  2002/08/20 14:43:51  mju
 * Use prevent_memfunc on header.
 *
 * Revision 1.14  2002/03/08 18:20:02  scowan
 * Added clear and ctors and deprecated mem... functions.
 *
 * Revision 1.13  2001/09/14 14:58:22  mju
 * No Mdlg in win32native.
 *
 * Revision 1.12  2000/12/15 15:36:19  msmith
 * Genitor documentation.
 *
 * Revision 1.11  2000/03/29 03:27:37  scowan
 * Added assignment operators.
 *
 * Revision 1.10  1999/11/19 14:20:45  mju
 * Use const for MdlgGet... prompt.
 *
 * Revision 1.9  1999/10/05  22:47:23  scowan
 * Changed header to use inheritance.
 *
 * Revision 1.8  1999/06/11 15:23:09  mju
 * Obj sel dlg.
 *
 * Revision 1.7  1999/05/07  21:23:18  mju
 * Header restruct.
 *
 * Revision 1.6  1999/04/08  19:10:12  mju
 * Add inclusion guards.
 *
 * Revision 1.5  1999/01/05  19:12:31  scowan
 * Swapped multiple keywords
 *
 * Revision 1.4  1996/12/20 16:37:34  coffee!dwilliss
 * Added __cplusplus things
 *
 * Revision 1.1  1995/12/12  16:57:19  coffee!dwilliss
 * Initial revision
 * \endif
**/

#ifndef INC_MI32_RVCPARMS_H
#define INC_MI32_RVCPARMS_H

#ifndef  INC_MI32_RVCDEFNS_H
   #include <mi32/rvcdefns.h>
#endif

#ifndef  INC_MI32_RVCTEXT_H
   #include <mi32/rvctext.h>
#endif

#ifndef  INC_MI32_MISTRUCT_H
   #include <mi32/mistruct.h>
#endif

//! Parameter header structure.
struct RVCPARMINFO : public RVCTEXTINFO {
   UINT16 usage;
   UINT16 version;
   UINT32 forobjtype;
   
   RVCPARMINFO (
      ) {Clear();}
   
   RVCPARMINFO (
      const RVCGENINFO& ginfo
      ) {Clear();*static_cast<RVCGENINFO*>(this) = ginfo;}
   
   //! Assignment operator
   RVCPARMINFO& operator= (
      const RVCGENINFO& ginfo          //!< RVCGENINFO structure to copy from
      ) {*static_cast<RVCGENINFO*>(this) = ginfo; return (*this);}
      
   void Clear (
      ) {memset(static_cast<void*>(this), 0, sizeof(*this));}
   
   };
typedef RVCPARMINFO RVCDPARMINFO;

PREVENT_MEMFUNC(RVCPARMINFO);

#define  DPARMUSAGE_Display         0
#define  DPARMUSAGE_Edit            1
#define  DPARMUSAGE_NumericOutput   2
#define  DPARMUSAGE_Surface         3
#define  DPARMUSAGE_Unspecified     99

//! Read parameter header.
inline int MfReadDispParmHeader (
   int fhandle,                        //!< Open file handle
   RVCINODENUM inode,                  //!< Parameter object inode
   RVCPARMINFO* info                   //!< Parameter header passed / returned
   ) {
   return (_MfReadHeader(fhandle,inode,info,sizeof(RVCDPARMINFO),RVCCONV_DispParm));
   }

//! Write parameter header.
inline int MfWriteDispParmHeader (
   int fhandle,                        //!< Open file handle
   RVCINODENUM inode,                  //!< Parameter object inode
   RVCPARMINFO* info                   //!< Parameter header to write
   ) {
   return (_MfWriteHeader(fhandle,inode,info,sizeof(RVCDPARMINFO),RVCCONV_DispParm));
   }

#if (defined(X_NATIVE) || defined(WIN32_MFC)) && !defined(DEPRECATE_GROUPKEY)

//! Pop-up dialog allowing user to select a display group layout object.
inline int MdlgGetDispGroupObject (
   MDLGPARENT dlgparent,               //!< Parent widget
   UNICODE *filename,                  //!< Default filename
   INT32 *inode,                       //!< Display group object inode passed/returned
   const void *prompt,                 //!< Prompt label
   RVCDPARMINFO *objinfo,              //!< Object header passed/returned
   MfFiltFuncProto filter=0,           //!< Filter function
   void *filtuserdata=0,               //!< Filter function data
   GETOBJFLAGS flags=GETOBJFLAG_None   //!< Get object flags (See rvcdefns.h)
   ) {
   return (MdlgGetObject(dlgparent,filename,inode,prompt,OTYPE_DISP_GROUP,RVCCONV_DispParm,objinfo,sizeof(RVCDPARMINFO),filter,filtuserdata,flags));
   }

//! Pop-up dialog allowing user to select a display layout object.
inline int MdlgGetDispLayoutObject (
   MDLGPARENT dlgparent,               //!< Parent widget
   UNICODE *filename,                  //!< Default filename
   INT32 *inode,                       //!< Display  object inode passed/returned
   const void *prompt,                 //!< Prompt label
   RVCDPARMINFO *objinfo,              //!< Object header passed/returned
   MfFiltFuncProto filter=0,           //!< Filter function
   void *filtuserdata=0,               //!< Filter function data
   GETOBJFLAGS flags=GETOBJFLAG_None   //!< Get object flags (See rvcdefns.h)
   ) {
   return (MdlgGetObject(dlgparent,filename,inode,prompt,OTYPE_DISP_LAYOUT,RVCCONV_DispParm,objinfo,sizeof(RVCDPARMINFO),filter,filtuserdata,flags));
   }

//! Pop-up dialog allowing user to select a display 3D simulation parameters object.
inline int MdlgGetDispSim3dObject (
   MDLGPARENT dlgparent,               //!< Parent widget
   UNICODE *filename,                  //!< Default filename
   INT32 *inode,                       //!< Display 3D simulation parameters object inode passed/returned
   const void *prompt,                 //!< Prompt label
   RVCDPARMINFO *objinfo,              //!< Object header passed/returned
   MfFiltFuncProto filter=0,           //!< Filter function
   void *filtuserdata=0,               //!< Filter function data
   GETOBJFLAGS flags=GETOBJFLAG_None   //!< Get object flags (See rvcdefns.h)
   ) {
   return (MdlgGetObject(dlgparent,filename,inode,prompt,OTYPE_DISP_SIM3D,RVCCONV_DispParm,objinfo,sizeof(RVCDPARMINFO),filter,filtuserdata,flags));
   }

#endif   //!< X_NATIVE || WIN32_MFC

extern "C" {
   //! Read the object.
   int MfReadParms (
      int handle,                      //!< Object handle
      MISTRUCTDATA *kwdata,            //!< Reading parameters
      void *data,                      //!< Data structure to fill in
      UINT32 flags                     //!< Flags
      );

   //! Write the object.
   int MfWriteParms (
      int handle,                      //!< Object handle
      MISTRUCTDATA *kwdata,            //!< Writing parameters
      void *data,                      //!< Data structure to write
      UINT32 flags                     //!< Flags
      );

   //! Close the object
   int MfCloseParms (
      int id,                          //!< Object handle
      RVCPARMINFO *info                //!< Structure 
      );

   //! Open the object and make sure it's the right OTYPE of this.
   int MfOpenParms (
      int fid,                         //!< Open file handle
      INT32 inode,                     //!< Object inode
      RVCPARMINFO *info,               //!< RVCPARMINFO structure to fill in
      UINT32 flags                     //!< Flags
      );

   //! Create the object and make sure it's the right OTYPE of this.
   int MfMakeParms (
      int fid,                         //!< Open file handle
      RVCPARMINFO *info,               //!< RVCPARMINFO structure to write from
      UINT32 flags                     //!< Flags
      );
   }

#endif

---