rvc/simple.h

Go to the documentation of this file.

#ifndef INC_RVC_SIMPLE_H
#define INC_RVC_SIMPLE_H

#ifndef INC_RVC_OBJECT_H
   #include <rvc/object.h>
#endif

namespace RVC {
#ifndef GENERATING_DOXYGEN_OUTPUT
class OBJMAKEPARMS;     // Forward Declarations
class OBJOPENPARMS;
#endif // GENERATING_DOXYGEN_OUTPUT

class SIMPLE : public RVC::OBJECT {       // Specify namespace in inheritance so that other "OBJECT's" do not get used as the parent
   public:

      SIMPLE (
         );

      SIMPLE (
         const RVC::SIMPLE& rhs
         );

      virtual ~SIMPLE (                   
         ) = 0;

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

      ERRVALUE GetDftNameDesc (        
         const RVC::OBJITEM& ParentObjItem,     
         RVC::DESCRIPTOR& Descriptor            
         );

      ERRVALUE GetDftNameDesc (        
         const RVC::OBJECT& ParentObject,       
         RVC::DESCRIPTOR& Descriptor            
         );

      ERRVALUE Make (
         const RVC::OBJECT& parent,             
#ifdef RVC_CREDENTIALS_MANDATORY
         const char* Source,
         const CREDENTIALS* Credentials         
#else
         const char* Source = 0,                   
         const CREDENTIALS* Credentials = 0           
#endif
         );

      ERRVALUE Make (
         const RVC::OBJECT& parent,             
         const RVC::DESCRIPTOR& Descriptor,
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS            
         );

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

      ERRVALUE Read (
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS            
         );

      ERRVALUE Read (
         const FILEPATH& filepath,              
         const MISTRING& ObjectPath,               
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS            
         );

      ERRVALUE Read (
         const RVC::OBJECT& object,             
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS            
         );

      DEPRECATED ERRVALUE Read (
         const RVC::OBJECT& parent,             
         const RVC::OBJECTNAME& name,              
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS            
         );

      ERRVALUE Read (
         const RVC::OBJECT& parent,             
         const RVC::DESCRIPTOR& Descriptor,     
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS            
         );

      ERRVALUE Read (
         const RVC::OBJITEM& ObjItem,        
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS            
         );

      ERRVALUE Read (
         const RVC::OBJECT& source,       
         const MIUNICODE *filename,       
         const MISTRING& ObjectPath,         
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS            
         );

      ERRVALUE Write (
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS            
         );

   private:
   
      virtual ERRVALUE v_GetDftNameDesc (
         const OBJECT& parent,                  
         DESCRIPTOR& Descriptor
         ) = 0;

      virtual ERRVALUE v_MakeData (             
         RVC::OBJMAKEPARMS& ObjMakeParms
         ) = 0;
         
      virtual ERRVALUE v_ReadData (             
         RVC::OBJOPENPARMS& ObjOpenParms
         ) = 0;

      virtual ERRVALUE v_WriteData (            
         RVC::OBJOPENPARMS& ObjOpenParms
         ) = 0;
         
      #ifndef GENERATING_DOXYGEN_OUTPUT
      virtual ERRVALUE v_OpenObject (OPENMODE OpenMode, MDLGPARENT parent, const CREDENTIALS* Credentials);
      #endif // GENERATING_DOXYGEN_OUTPUT

   };

}     

#endif      

---