simple.h

Go to the documentation of this file.

/**
 * \file rvc/simple.h 
 * \brief interface for the RVCSIMPLE class.
 *
 * \if NODOC
 * $Id: simple.h_v 1.17 2004/02/06 22:36:33 scowan Exp $
 *
 * $Log: simple.h_v $
 * Revision 1.17  2004/02/06 22:36:33  scowan
 * Added methods to get the default name and desc.
 *
 * Revision 1.16  2003/10/07 17:30:40  scowan
 * Object virtual method changes.
 *
 * Revision 1.15  2003/09/30 16:52:06  dwilliss
 * Doxygen
 *
 * Revision 1.14  2003/09/25 21:56:58  dwilliss
 * doxygen
 *
 * Revision 1.13  2003/09/15 13:49:45  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.12  2003/05/13 14:06:53  scowan
 * Added override to open object.
 *
 * Revision 1.11  2002/12/06 15:10:00  scowan
 * Fixed for genator docs.
 *
 * Revision 1.10  2002/04/05 22:34:17  scowan
 * Cleaned up.
 *
 * Revision 1.9  2002/01/09 20:13:12  scowan
 * Added source parameter for make method.
 *
 * Revision 1.8  2001/06/15 16:17:41  scowan
 * Added simple read method for current object.
 *
 * Revision 1.7  2001/06/14 16:14:23  scowan
 * Changed source type..
 *
 * Revision 1.6  2001/06/13 21:38:43  scowan
 * Added to RVC namespace.
 *
 * Revision 1.5  2001/06/13 14:54:44  scowan
 * Added new make method.
 *
 * Revision 1.4  2000/12/01 14:58:34  scowan
 * MAC errors.
 *
 * Revision 1.3  2000/12/01 14:54:00  scowan
 * Fixed MAC errors.
 *
 * Revision 1.2  2000/10/19 21:14:51  scowan
 * Checked in for vacation.
 *
 * Revision 1.1  2000/09/29 15:26:55  scowan
 * Initial revision
 *
 * \endif
**/

//!   \class RVC::SIMPLE rvc/simple.h
//!   \brief Interface for RVC objects that support a Read Once, Write Once
//!   paradigm.  Derived classes do not open / close the rvc object.
//!
//!   This class inherits from RVC::OBJECT
//!   
//!   RVC Object Types that this class supports: Derived class
//!
//!   Default RVC Object Type for this class: Derived class
//!
//!   Valid parents for this class: Derived class

#ifndef INC_RVC_SIMPLE_H
#define INC_RVC_SIMPLE_H

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

namespace RVC {

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

      //! Default Constructor
      SIMPLE (
         );

      //! Copy constructor
      SIMPLE (
         const RVC::SIMPLE& rhs
         );

      //! Destructor, pure virtual
      virtual ~SIMPLE (                   //! Destructor, pure virtual
         ) = 0;

      //! Assignment
      RVC::SIMPLE& operator= (                  //! Assignment operator
         const RVC::SIMPLE& rhs
         );

      //! Obtain default name and description information from derived class
      ERRVALUE GetDftNameDesc (        
         const RVC::OBJITEM& ParentObjItem,     //!< Parent rvc object item
         RVC::OBJECTNAME& name,                 //!< Default generated name RETURNED
         RVC::OBJECTDESC& desc                  //!< Default generated description RETURNED
         );

      //! Obtain default name and description information from derived class
      ERRVALUE GetDftNameDesc (        
         const RVC::OBJECT& ParentObject,       //!< Parent rvc object
         RVC::OBJECTNAME& name,                 //!< Default generated name RETURNED
         RVC::OBJECTDESC& desc                  //!< Default generated description RETURNED
         );

      //! Create new rvc object of derived class type using default name and desc
      //! This method will attach this instance to the rvc object after writing the data.  This instance file handle will be closed
      ERRVALUE Make (
         const RVC::OBJECT& parent,             //!< Parent rvc object to create derived class under
         const char* Source = 0                    //!< Who created this rvc object, 0 to use result from GetAppName()
         );

      //! Create new rvc object of derived class type with given name and desc
      //! This method will attach this instance to the rvc object after writing the data.  This instance file handle will be closed
      ERRVALUE Make (
         const RVC::OBJECT& parent,             //!< Parent rvc object to create derived class under
         const RVC::OBJECTNAME& name,              //!< Name of rvc object
         const RVC::OBJECTDESC& desc,              //!< Description of rvc object
         const char* Source = 0                    //!< Who created this rvc object, 0 to use result from GetAppName()
         );

      //! Create new rvc object of derived class type with given RVCOBJITEM
      //! This method will attach this instance to the rvc object after writing the data.  This instance file handle will be closed
      ERRVALUE Make (
         const RVC::OBJITEM& ObjItem,
         const char* Source = 0                    //!< Who created this rvc object, 0 to use result from GetAppName()
         );

      //! Read data from rvc object, data stored in derived class
      //!
      //! This method will open the file, if not open already, and after reading the data, close its instance of the file.
      //! If the file was open before the call, this method still closes the file.  This is by design.
      ERRVALUE Read (
         );

      //! Read data from named rvc object, data stored in derived class
      //!
      //! This method will open the file, if not open already, and after reading the data, close its instance of the file.
      //! If the file was open before the call, this method still closes the file.  This is by design.
      ERRVALUE Read (
         const FILEPATH& filepath,              //!< Path to RVC file
         const MISTRING& ObjectPath             //!< Path to requested rvc object
         );

      //! Read data from rvc object, data stored in derived class
      //!
      //! This method will open the file, if not open already, and after reading the data, close its instance of the file.
      //! If the file was open in this instance before the call, this method still closes the file.  This is by design.
      ERRVALUE Read (
         const RVC::OBJECT& object              //!< RVC Object to read data from
         );

      //! Read data from found rvc object, data stored in derived class
      //!
      //! This method will open the file, if not open already, and after reading the data, close its instance of the file.
      //! If the file was in this instance open before the call, this method still closes the file.  This is by design.
      ERRVALUE Read (
         const RVC::OBJECT& parent,             //!< Parent rvc object
         const RVC::OBJECTNAME& name               //!< Name of rvc object to locate and read from
         );

      //! Read data from defined rvc object, data stored in derived class
      //!
      //! This method will open the file, if not open already, and after reading the data, close its instance of the file.
      //! If the file was in this instance open before the call, this method still closes the file.  This is by design.
      ERRVALUE Read (
         const RVC::OBJITEM& ObjItem         //!< This contains the file and rvc object location information
         );

      //! Read data from found rvc object, data stored in derived class
      //!
      //! This method will open the file, if not open already, and after reading the data, close its instance of the file.
      //! If the file was in this instance open before the call, this method still closes the file.  This is by design.
      ERRVALUE Read (
         const RVC::OBJECT& source,       //!< Source rvc object used if 'filename' is a relative path
         const UNICODE *filename,         //!< Full or relative path to the rvc file to open
         const MISTRING& ObjectPath       //!< Full name of rvc object obtained from GetObjectPath()
         );

      //! Overwrite existing derived class type with current information
      //!
      //! This method will open the file, if not open already, and after writing the data, close its instance of the file.
      //! If the file was open in this instance before the call, this method still closes the file.  This is by design.
      ERRVALUE Write (
         );

   private:
   
      virtual ERRVALUE v_GetDftNameDesc (       //! Obtain default name and description information from derived class
         const OBJECT& parent,               //!< Parent rvc object to create derived class under
         OBJECTNAME& name,
         OBJECTDESC& desc
         ) = 0;

      virtual ERRVALUE v_ReadData (             //! Read specific data method for derived classes
         ) = 0;

      virtual ERRVALUE v_WriteData (            //! Write specific data method for derived classes
         const RVCGENINFO& ginfo
         ) = 0;
         
      #ifndef GENERATING_DOXYGEN_OUTPUT
      //! Implementation of RVC::OBJECT virtual methods
      virtual ERRVALUE v_OpenObject (OPENMODE OpenFlags, MDLGPARENT parent);
      #endif // GENERATING_DOXYGEN_OUTPUT

   };

}     //! End of RVC namespace

#endif      //!< INC_RVC_SIMPLE_H

---