rvc/array.h

Go to the documentation of this file.

#ifndef INC_RVC_ARRAY_H
#define INC_RVC_ARRAY_H

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

namespace RVC {

#ifndef GENERATING_DOXYGEN_OUTPUT
class ARRAYHANDLE;      // Forward declarations
struct ARRAYINFO;
class OBJMAKEPARMS;
#endif // GENERATING_DOXYGEN_OUTPUT

class ARRAY : public RVC::OBJECT {
   public:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      class MAKEPARMS;
      #endif // GENERATING_DOXYGEN_OUTPUT
      
      ARRAY (
         );

      ARRAY (
         const RVC::ARRAY& obj
         );

      virtual ~ARRAY (
         );

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

      template <class _CT>
      INT32 Append (
         const _CT& item
         ) {
         if (sizeof(_CT) != m_ItemSize) return (EBadFuncParm);
         INT32 retval = GetNumItems();
         ERRVALUE err;
         if ((err = Resize(retval + 1)) < 0) return (err);
         if ((err = Write(retval, &item)) < 0) return (err);
         return (retval);
         }

      INT32 GetItemSize (
         ) const { return (m_ItemSize); }
         
      INT32 GetNumItems (
         ) const;

      bool IsInverted (
         ) const;
      
      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 RVC_DEFAULT_CREDENTIALS            
#endif
         );

      INT32 Read (
         INT32 ItemNum,
         void *ptr
         ) const;

      ERRVALUE Resize (
         INT32 NewNumItems
         );

      INT32 Write (
         INT32 ItemNum,
         const void* ptr
         );

   protected:     
      
      ERRVALUE Make (
         const RVC::OBJECT& parent,
         OBJMAKEPARMS& ObjMakeParms
         );

      ERRVALUE OpenObject (               
         OPENMODE OpenFlags,
         ARRAYINFO& newinfo,
         int HeaderSize,
         int HeaderType,
         MDLGPARENT parent,
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS            
         );
         
   protected:
   
      virtual ERRVALUE v_OpenObject (OPENMODE OpenFlags, MDLGPARENT parent, const CREDENTIALS* Credentials);            
      
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      ARRAYHANDLE* m_ArrayHandle;
      INT32 m_ItemSize;
      
      virtual ERRVALUE v_CloseObject ();           
      virtual RVC::OBJTYPE v_GetDftObjectType () const;
      virtual bool v_IsObjectOpen () const;        
      #endif // GENERATING_DOXYGEN_OUTPUT
   };


class ARRAY::MAKEPARMS {
   public:
      explicit MAKEPARMS (
         INT32 ItemSize
         ) : m_ItemSize(ItemSize) {}
            
      INT32 GetItemSize (
         ) const { return (m_ItemSize); }
            
      void SetItemSize (
         INT32 ItemSize
         ) { m_ItemSize = ItemSize; }
      
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      INT32 m_ItemSize; 
      #endif // GENERATING_DOXYGEN_OUTPUT
   };
      
}     

#endif   

---