gModel-class            package:MVCClass            R Documentation

_C_l_a_s_s "_g_M_o_d_e_l": _A _v_i_r_t_u_a_l _c_l_a_s_s _f_o_r _m_o_d_e_l_s

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

     gModel is a virtual class from which all other model classes will
     inherit. Model objects will be responsible for storing and
     updating the data sets.

_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:

     '_m_o_d_e_l_D_a_t_a': the actual model data 

     '_l_i_n_k_D_a_t_a': a list of the functions to link this data to its
          parent and child models (if it has any) 

     '_v_i_r_t_u_a_l_D_a_t_a': data that pertains to the views of this model 

     '_m_o_d_e_l_N_a_m_e': the name of the model (will be the same name as the
          MVC) 

     '_m_o_d_e_l_V_a_r': a list of variables that refer to the modelData (for
          instance this may be t-test values that were calculated from
          the modelData) 

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

     _l_i_n_k_D_a_t_a<- Sets the 'linkData' slot 

     _l_i_n_k_D_a_t_a Returns the 'linkData' slot 

     _m_o_d_e_l_D_a_t_a<- Sets the 'modelData' slot 

     _m_o_d_e_l_D_a_t_a Returns the 'modelData' slot 

     _m_o_d_e_l_N_a_m_e<- Sets the 'modelName' slot 

     _m_o_d_e_l_N_a_m_e Returns the 'modelName' slot 

     _v_i_r_t_u_a_l_D_a_t_a<- Sets the 'virtualData' slot 

     _v_i_r_t_u_a_l_D_a_t_a Returns the 'virtualData' slot 

     _m_o_d_e_l_V_a_r<- Sets the 'modelVar' slot 

     _m_o_d_e_l_V_a_r Returns the 'modelVar' slot 

     Also, all models will have an updateModel method that will be
     defined in the packages that use this package (for example, iSPlot
     and iSNetwork).  The updateModel method will be called by a
     gUpdateDataMessage object when the data needs to be updated. 
     Another method that may be defined for certain models is the
     provideInfo method that will return model information when it is
     asked for by a gAskAncestorMessage object.

_A_u_t_h_o_r(_s):

     Elizabeth Whalen

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

     'dfModel-class'

_E_x_a_m_p_l_e_s:

