FLCatches               package:FLCore               R Documentation

_C_l_a_s_s _F_L_C_a_t_c_h_e_s

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

     'FLCatches' is a class that extends 'list' through 'FLlst' but
     implements a set of features that give a little bit more structure
     to list objects. The elements of 'FLCatches' must all be of class
     'FLCatch'. It implements a lock mechanism that, when turned on,
     does not allow the user to increase or decrease the object length.

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


     ._D_a_t_a The data. 'list'.

     _n_a_m_e_s Names of the list elements. 'character'.

     _d_e_s_c Description of the object. 'character'.

     _l_o_c_k Lock mechanism, if turned on the length of the list can not
          be modified by adding or removing elements. 'logical'.

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


          FLlst list

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


     _c_a_t_c_h(_F_L_C_o_r_e) : Accessor method for the _catch_ slots. Returns an
          object of class 'FLQuants-class'.

      ' signature(object=FLCatches) '

     _c_a_t_c_h._n(_F_L_C_o_r_e) : Accessor method for the _catch.n_ slots. Returns
          an object of class 'FLQuants-class'.

      ' signature(object=FLCatches) '

     _c_a_t_c_h._w_t(_F_L_C_o_r_e) : Accessor method for the _catch.wt_ slots.
          Returns an object of class 'FLQuants-class'.

      ' signature(object=FLCatches) '

     _d_i_s_c_a_r_d_s(_F_L_C_o_r_e) : Accessor method for the _discards_ slots.
          Returns an object of class 'FLQuants-class'.

      ' signature(object=FLCatches) '

     _d_i_s_c_a_r_d_s._n(_F_L_C_o_r_e) : Accessor method for the _discards.n_ slots.
          Returns an object of class 'FLQuants-class'.

      ' signature(object=FLCatches) '

     _d_i_s_c_a_r_d_s._w_t(_F_L_C_o_r_e) : Accessor method for the _discards.wt_ slots.
          Returns an object of class 'FLQuants-class'.

      ' signature(object=FLCatches) '

     _l_a_n_d_i_n_g_s(_F_L_C_o_r_e) : Accessor method for the _landings_ slots.
          Returns an object of class 'FLQuants-class'.

      ' signature(object=FLCatches) '

     _l_a_n_d_i_n_g_s._n(_F_L_C_o_r_e) : Accessor method for the _landings.n_ slots.
          Returns an object of class 'FLQuants-class'.

      ' signature(object=FLCatches) '

     _l_a_n_d_i_n_g_s._w_t(_F_L_C_o_r_e) : Accessor method for the _landings.wt_ slots.
          Returns an object of class 'FLQuants-class'.

      ' signature(object=FLCatches) '

     _c_a_t_c_h._q(_F_L_C_o_r_e) : Accessor method for the _catch.q_ slots. Returns
          an object of class 'FLQuants-class'.

      ' signature(object=FLCatches) '

     _p_r_i_c_e(_F_L_C_o_r_e) : Accessor method for the _price_ slots. Returns an
          object of class 'FLQuants-class'.

      ' signature(object=FLCatches) '

     _F_L_F_l_e_e_t(_F_L_C_o_r_e) : Conversion method of a FLFleet object from a
          FLCatches object

      ' signature(object=FLCatches) '

     _F_L_M_e_t_i_e_r(_F_L_C_o_r_e) : Conversion method of a FLMetier object from a
          FLCatches object

      ' signature(catches=FLCatches) '

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

     The FLR Team

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

     catch, catch.n, catch.wt, discards, discards.n, discards.wt,
     FLFleet, FLMetier, landings, landings.n, landings.wt, price,
     FLlst, list

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

     # creation
     catch1 <- FLCatch(name='catch1')
     catch2 <- FLCatch(name='catch2')
     lst.catches <- FLCatches(catch1,catch2)

     # getters
     catch(lst.catches) # get a FLQuants list over the species

