rvc/serialze.h

Go to the documentation of this file.

#ifndef INC_RVC_SERIALZE_H
#define INC_RVC_SERIALZE_H

#ifndef INC_RVC_TEXT_H
   #include <rvc/textobj.h>
#endif

#ifndef INC_RVC_DISPPARMUSAGE_H
   #include <rvc/dispparmusage.h>
#endif

namespace RVC {

class SERIALIZE : public RVC::TEXTOBJ {
   public:
         
      #ifndef GENERATING_DOXYGEN_OUTPUT
      class MAKEPARMS;
      class FILTER_USAGEFOROBJTYPE;
      #endif
      
      SERIALIZE (
         );

      SERIALIZE (
         const RVC::SERIALIZE& obj
         );

      virtual ~SERIALIZE (
         );

      RVC::SERIALIZE& operator= (
         const RVC::SERIALIZE& rhs
         );

      DISPPARMUSAGE GetUsage ( 
         ) const;

      UINT16 GetVersion (
         ) const;

      RVC::OBJTYPE GetForObjectType (
         ) const;

      static RVC::OBJTYPESET GetObjTypeSet (
         );
         
      static bool IsSerialize (
         RVC::OBJTYPE ObjType
         );
         
      ERRVALUE Make (
         const RVC::OBJECT& parent,             
         const RVC::DESCRIPTOR& Descriptor,
         const MAKEPARMS& MakeParms,
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS      
         );

      ERRVALUE Make (
         RVC::OBJITEM& ObjItem,              
         const MAKEPARMS& MakeParms,
#ifdef RVC_CREDENTIALS_MANDATORY
         const char* Source,                 
         const CREDENTIALS* Credentials   
#else
         const char* Source = 0,                
         const CREDENTIALS* Credentials = 0     
#endif
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      virtual OBJTYPE v_GetDftObjectType () const;
      virtual ERRVALUE v_OpenObject (OPENMODE OpenMode, MDLGPARENT parent, const CREDENTIALS* Credentials);
      virtual bool v_ValidateObjectType (const OBJTYPE otype) const;
      #endif // GENERATING_DOXYGEN_OUTPUT

   };


class SERIALIZE::MAKEPARMS : public TEXTOBJ::MAKEPARMS {
   public:
      MAKEPARMS (
         RVC::OBJTYPE ObjType,
         UINT16 Version = 1,                    
         OBJTYPE ForObjType = OBJTYPE_All,      
         DISPPARMUSAGE Usage = DISPPARMUSAGE_Display        
         );
         
      DISPPARMUSAGE GetUsage (
         ) const;

      UINT16 GetVersion (
         ) const;

      RVC::OBJTYPE GetForObjectType (
         ) const;

      void SetUsage (
         DISPPARMUSAGE usage
         );

      void SetVersion (
         UINT16 version
         );

      void SetForObjectType (
         RVC::OBJTYPE objtype
         );

   };


class SERIALIZE::FILTER_USAGEFOROBJTYPE : public RVC::OBJECT::FILTER {
   public:
      FILTER_USAGEFOROBJTYPE (
         DISPPARMUSAGE usage,                      
         OBJTYPE forobjtype = OBJTYPE_All    
         ): m_usage(usage), m_forobjtype(forobjtype) { }
      void SetForObjType (
         OBJTYPE forobjtype
         ) { m_forobjtype = forobjtype; }
      void SetUsage (
         DISPPARMUSAGE usage
         ) { m_usage = usage; }
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      DISPPARMUSAGE m_usage;
      OBJTYPE m_forobjtype;
      virtual bool Filter (const RVC::OBJECT& obj);
      #endif
   };

}     

#endif   

---