clusterModule-class        package:goCluster        R Documentation

_C_l_a_s_s "_c_l_u_s_t_e_r_M_o_d_u_l_e" _r_e_p_r_e_s_e_n_t_s _t_h_e _b_a_s_e _c_l_a_s_s _f_o_r _a_l_l _g_o_C_l_u_s_t_e_r
_o_b_j_e_c_t_s

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

     This is the central class in 'goCluster' and is being used to
     abstract the configuration and execution of 'goCluster'-objects.

_D_e_t_a_i_l_s:

     'goCluster' has been created as an object oriented package to
     build a modular structure that allows to easily modify and extend
     the functionality of the package. The 'clusterModule'-class
     abstracts the configuration and execution of the different
     modules.

     The 'config', 'setup', and 'setup<-' methods can be used for the
     module configuration while the 'execute' and 'reset' methods are
     concerned with the execution of the objects. 

     For further information on extending 'goCluster' and the internal
     structures you are referred to the "Developers Manual" of
     goCluster which is included in the package as a vignette.

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

     '_c_o_n_f_i_g': Object of class '"list"'. A list of functions that will
          be called by the 'config' method of this object. The name of
          each list entry specifies the slot that will be set by the
          function.

     '_s_e_t_u_p': Object of class '"list"'. A list of functions that will
          be used by the 'setup' and 'setup<-' methods of this object.
          The 'setup' method will only read the slot names and return
          the corresponding slots of the object as a list. Such a list
          can be used with the 'setup<-' call in order to assign the
          configuration to a new 'goCluster' object. The 'setup<-' will
          use the functions stored in this list to verify that each
          setting is in the limits defined for this slot.

     '_e_x_e_c_u_t_e': Object of class '"function"'. This is the main function
          of the object that will be called from the 'execute' function
          of this object.

     '_r_e_s_e_t': Object of class '"list"'. A list that names the slots
          which hold protected results and holds the empty value for
          each of these slots. In case any of these slots contains
          data, the 'execute' function will fail on this object. The
          'reset' method will fill each of the slots with the
          corresponding empty value.

     '_c_h_i_l_d_r_e_n': Object of class '"character"'. A vector of names that
          specifies the children of this object. This vector enables
          the different methods of a 'clusterModule' to automatically
          recurse through a  "tree" of objects.

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

     _c_o_n_f_i_g 'signature(object = "clusterModule")': This will call the
          interactive setup for the object and iterate through the
          elements in the 'config' slot. 

     _e_x_e_c_u_t_e 'signature(object = "clusterModule")': This will execute
          the object and all of its children. 

     _e_x_e_c_u_t_e<- 'signature(object = "clusterModule")': This will first
          call the 'setup<-' method to set the configuration.
          Subsequently 'execute' will be called. This method simplifies
          configuration and execution of a 'goCluster' object to a
          single call.

     _r_e_s_e_t 'signature(object = "clusterModule")': Resets the object by
          setting each of the slots named in the 'reset' slot of this
          object to the corresponding element in that list.

     _s_e_t_u_p 'signature(object = "clusterModule")': Return the
          configuration of the object as a list. 

     _s_e_t_u_p<- 'signature(object = "clusterModule")': Assigns the given
          list as a configuration to the object. The method will check
          each setting against the functions specified in the 'setup'
          slot of this object. 

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

     Gunnar Wrobel, <URL: work@gunnarwrobel.de>, <URL:
     http://www.gunnarwrobel.de>.

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

     'goCluster-class',

