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:

