externalStorage-class     package:externalVector     R Documentation

_C_l_a_s_s "_e_x_t_e_r_n_a_l_S_t_o_r_a_g_e", _b_a_s_e _c_l_a_s_s _f_o_r _e_x_t_e_r_n_a_l _s_t_o_r_a_g_e _f_o_r
_o_b_j_e_c_t_s _o_f _c_l_a_s_s "_e_x_t_e_r_n_a_l_V_e_c_t_o_r_W_i_t_h_S_t_o_r_a_g_e"

_D_e_s_c_r_i_p_t_i_o_n:

     The '"externalStorage"' class represents the base class of the
     storage backend implementation used by the class
     '"externalVectorWithSToraghe"'. A pointer to the external storage
     allocated or accessed by an object of class '"externalStorage"' is
     kept in an external pointer.

_O_b_j_e_c_t_s _f_r_o_m _t_h_e _C_l_a_s_s:

     A virtual Class: No objects may be created from it.

_S_l_o_t_s:


     '_p_t_r': Object of class '"externalptr"', keeps the pointer to the
          external storage. 

     '_t_y_p_e': Object of class '"vector"', a vector object of length one
          representing the type of object stored in the external
          storage. Usually one of the basic R vector types. 

     '_l_e_n_g_t_h': Object of class '"integer"', Cached value for the length
          of the vector stored in the external storage. 

_E_x_t_e_n_d_s:

     Class '"externalResource"', directly.

_M_e_t_h_o_d_s:

     Signature components for the methods:

       resource  The class "externalStorage"
       x         The class "externalStorage"
       ptr       The class "externalptr"
       size      The class "ANY"
       type      The class "ANY"


     _a_l_l_o_c_a_t_o_r(_r_e_s_o_u_r_c_e): The allocator to be used by default with this
          'resource'. Returns an object of class '"gcAllocator"'. 

     _g_e_t_P_o_i_n_t_e_r(_r_e_o_u_r_c_e): Return the 'ptr' slot. 

     _i_n_i_t_i_a_l_i_z_e_R_e_s_o_u_r_c_e(_r_e_s_o_u_r_c_e, _p_t_r, _s_i_z_e, _t_y_p_e, ...): Set the 'ptr'
          slot of resource to 'ptr'. 

     _i_n_i_t_i_a_l_i_z_e(._O_b_j_e_c_t, _t_y_p_e = _l_o_g_i_c_a_l(_1), _l_e_n_g_t_h = _a_s._i_n_t_e_g_e_r(_0)): 
          This checks the validity of 'type' and 'length' arguments and
          coerce the 'length' argument to class '"integer"' before
          using them to set the corresponding slots. Finally a call to
          'callNextMethod' is made to use the initializer for class
          '"externalResource"' which, via a call to the
          'initializeResource' method above sets 'ptr' slot. 

     _i_n_t_e_r_n_a_l_T_y_p_e(_x): The type of object to be stored within the
          resource. It is an R basic vector type ('"logical"',
          '"integer"', '"numeric"', '"complex"', '"character"' or
          '"list"'). 

     _g_e_t_N_a_t_i_v_e_S_t_o_r_a_g_e_M_e_t_h_o_d_s(_x): Get the '"externalptr"' stored in the
          '"nativeStorageMethods"' object associated with a particular
          subclass of '"externalStorage"' and a basic R vector type. 

_S_e_e _A_l_s_o:

     'setExternalStorageClass' for how to set a subclass of
     '"externalStorage"'.

     'nativeStorageMethods-class' for the C structure containing C
     function pointers for a particular storage methods class.

     'externalVectorWithStorage-class' for how the '"externalStorage"'
     class is used.

     'simpleStorage-class' for a simple implementation of
     '"externalStorage"'.

