sml/object.h

Go to the documentation of this file.

/******************************************************************************
 *
 * \file sml/object.h
 * \brief SML OBJECT
 *
 * \if NODOC
 * $Log: object.h_v $
 * Revision 1.7  2011/10/12 14:31:15  mju
 * Remove redundant hdrs.
 *
 * Revision 1.6  2007/12/31 17:41:00  bcolombe
 * Added COORDOP_LIST to SML::OBJECT for use in ObjectToMap
 *
 * Revision 1.5  2007/09/06 15:54:04  scowan
 * Fixed some comments.
 *
 * Revision 1.4  2007/05/10 21:57:42  dwilliss
 * Added AddRef/Release
 *
 * Revision 1.3  2007/05/10 20:46:36  dwilliss
 * removed some unused methods and members
 *
 * Revision 1.2  2007/05/08 15:46:07  dwilliss
 * SML namespace
 *
 * Revision 1.1  2007/05/04 20:44:14  dwilliss
 * Initial revision
 *
 * \endif
*/
/*****************************************************************************/

#ifndef INC_SML_OBJECT_H
#define INC_SML_OBJECT_H

#ifndef  INC_SML_STYPE_H
   #include <sml/stype.h>
#endif

#ifndef INC_RVC_OBJITEM_H     // For RVC::OBJITEM and RVC::OBJITEMLIST
   #include <rvc/objitem.h>
#endif

#ifndef  INC_MI32_ELEMTYPE_H
   #include <mi32/elemtype.h>
#endif

#ifndef INC_MI32_COORDOP_H
   #include <mi32/coordop.h>
#endif

#ifdef RVCSYSDLL
   #define RVCSYSLIBEXPORT MI_DLLEXPORT
   #define RVCSYSLIBCLASSEXPORT MI_DLLCLASSEXPORT
#else
   #define RVCSYSLIBEXPORT MI_DLLIMPORT
   #define RVCSYSLIBCLASSEXPORT MI_DLLCLASSIMPORT
#endif

#ifndef GENERATING_DOXYGEN_OUTPUT
namespace RVC {
   class FILEHANDLE;
   class OBJECTOBSERVER;
   class OBJECT;
   }
#endif

namespace SML {
class CONTEXT;
class ELEMDATA;
class GEOSTRUCT;
class OBJPROXY;

/*****************************************************************************/
class RVCSYSLIBCLASSEXPORT OBJECT {
   public:

      void AddRef (
         );

      // Allocate an SML::OBJECT base class.  This is used to hold object
      // information (name, desc, etc) for objects we don't use have any
      // derived class for.  The caller is responsibile for makeing sure
      // the returned pointer is freed some time.
      static OBJECT* Allocate (
         RVC::OBJTYPE objtype
         );

      ERRVALUE DeleteExisting (
         );

      //============================ Get Methods ========================
      int GetCurElemNum (
         ELEMTYPE elemtype
         ) const;

      int GetElemData (
         ELEMDATA** pElemData,
         ELEMTYPE ElemType,
         bool bAllocIfNeeded = false
         ); 

      const FILEPATH& GetFilePath (
         ) const;


      RVC::OBJECT* GetInterfaceBase (
         ) const;

      RVC::OBJITEM& GetObjItem (
         );

      const RVC::OBJITEM& GetObjItem (
         ) const;

      RVC::OBJTYPE GetObjType (
         ) const;

      STYPE GetSMLSTYPE (
         ) const;

      bool IsDirty (
         ) const;

      void Release (
         );

      //============================ Set Methods ========================

      void SetDirty (
         bool bDirty = true
         );

      void SetFilePath (
         const FILEPATH& filepath
         );

      void SetIsUserTempObject (
         bool state
         );

      void SetObjItem (
         const RVC::OBJITEM& item
         ) ;

      ERRVALUE Setup (
         const RVC::OBJITEM& item,
         const RVC::CREDENTIALS* Credentials
         ) ;

      // ========================= Other methods ===========================
      void Close (
         bool CloseDatabasesToo = false
         );

      void CloseDatabases (
         );

      int ConvertPointMapToObject (
         const DPOINT2D& src,
         const GEOSTRUCT* SrcGeoref,
         DPOINT2D* pDest
         );

      int ConvertPointObjectToMap (
         const DPOINT2D& src,
         const GEOSTRUCT* DestGeoref,
         DPOINT2D* pDest
         );

      void Free (
         );

      const RVC::CREDENTIALS* GetCredentials (
         ) const;

      OBJECT* Next (
         ) const;

   #ifndef GENERATING_DOXYGEN_OUTPUT
   #if defined(RVCSYSDLL) 
      // XXX Still used in qqcode.c
      DEPRECATED_MSG("Call GetInterface() and Open that") 
      int Open (
         int mode    
         );
   #endif
   #endif


      bool IsDoingForEach (
         ELEMTYPE ElemType
         ) const;

      bool IsUserTempObject (
         ) const;

      DEPRECATED int ReadGeoref (
         GEOSTRUCT **pGeostruct,
         const RVC::OBJITEM& ObjItem
         );

      int ReadGeoref (
         GEOSTRUCT **pGeostruct,
         const RVC::OBJITEM* ObjItem = 0
         );

      void OnInterfaceDestroy (
         );

      void OnInterfaceAttach (
         const RVC::OBJITEM& ObjItem
         );

      void OnInterfaceDetach (
         );

   #ifndef GENERATING_DOXYGEN_OUTPUT
      static void SetRVCInterfaceProxy (
         OBJPROXY* proxy
         );

      void SetCredentials (
         const RVC::CREDENTIALS* credentials
         );

   #ifdef RVCSYSDLL  // These methods are public but only for use inside RVCSYS

      ERRVALUE OpenFileReal (
         int mode    
         );

      RVCINODENUM GetInodeReal (
         ) const;

      ERRVALUE OpenReal (
         int mode,
         const RVC::CREDENTIALS* Credentials = 0
         );
   #endif
   #endif

   protected:

      static OBJPROXY* s_Proxy;
      mutable RVC::OBJECT* m_Interface;      // Get method may create one and set it the first time it's called

      void ConstructInterface (
         RVC::OBJTYPE
         ) const;

      // Constructor
      OBJECT (
         STYPE type,
         CONTEXT* context
         );

      // Destructor
      virtual ~OBJECT (
         );

   #ifndef GENERATING_DOXYGEN_OUTPUT

      virtual int v_OpenLow (
         int mode
         );

      virtual void v_CloseLow (
         );

      virtual RVC::OBJTYPE v_GetObjType (
         ) const;

   #ifdef RVCSYSDLL
   protected:
   #else
   private:
   #endif
      INT32 m_RefCount;

      OBJECT* m_prev;
      OBJECT* m_next;
      bool m_SystemTempObject;      
      bool m_UserTempObject;     
      //bool m_RegionIsObject;      //!< region was created with GetInputRegion()
      bool m_Dirty;              
      bool m_bIsOpen;            
      //bool m_FreeInDestructor; //!< Not in the context's object list
      RVC::OBJITEM m_ObjItem;
      STYPE m_stype;
      bool m_bOpenForWrite;
      GEOSTRUCT *m_georef;
      ELEMDATA *m_db[ELEMTYPE_NumTypes];        
      UINT8 m_DoingForEach[ELEMTYPE_NumTypes];  
      INT32  m_ElemNum[ELEMTYPE_NumTypes];      
      CONTEXT* m_context;
      RVC::FILEHANDLE* m_fhandle;
      RVC::OBJECTOBSERVER* m_Observer;
      RVC::CREDENTIALS* m_Credentials;
      SPATREF::COORDOP_LIST* m_OpList;

      friend class CONTEXT;      
      friend class VM;
      friend class SYMBOL;
   #endif // GENERATING_DOXYGEN_OUTPUT

   };
} // end of SML namespace

typedef SML::OBJECT SMLOBJECT;


#undef RVCSYSLIBEXPORT
#undef RVCSYSLIBCLASSEXPORT

#endif      //  INC_SML_OBJECT_H

---