FLMetiers               package:FLCore               R Documentation

_C_l_a_s_s _F_L_M_e_t_i_e_r_s

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

     'FLMetiers' 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 'FLMetiers' must all be of class
     'FLMetier'. 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 vector

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


     _c_a_t_c_h(_F_L_C_o_r_e) : Accessor method getting the FLCatch catch slots.
          Returns a FLQuants

      ' signature(object=missing) '

     _c_a_t_c_h._n(_F_L_C_o_r_e) : Accessor method getting the FLCatch catch.n
          slots. Returns a FLQuants

      ' signature(object=missing) '

     _c_a_t_c_h._w_t(_F_L_C_o_r_e) : Accessor method getting the FLCatch catch.wt
          slots. Returns a FLQuants

      ' signature(object=missing) '

     _d_i_s_c_a_r_d_s(_F_L_C_o_r_e) : Accessor method getting the FLCatch discards
          slots. Returns a FLQuants

      ' signature(object=missing) '

     _d_i_s_c_a_r_d_s._n(_F_L_C_o_r_e) : Accessor method getting the FLCatch
          discards.n slots. Returns a FLQuants

      ' signature(object=missing) '

     _d_i_s_c_a_r_d_s._w_t(_F_L_C_o_r_e) : Accessor method getting the FLCatch
          discards.wt slots. Returns a FLQuants

      ' signature(object=missing) '

     _l_a_n_d_i_n_g_s(_F_L_C_o_r_e) : Accessor method getting the FLCatch landings
          slots. Returns a FLQuants

      ' signature(object=missing) '

     _l_a_n_d_i_n_g_s._n(_F_L_C_o_r_e) : Accessor method getting the FLCatch
          landings.n slots. Returns a FLQuants

      ' signature(object=missing) '

     _l_a_n_d_i_n_g_s._w_t(_F_L_C_o_r_e) : Accessor method getting the FLCatch
          landings.wt slots. Returns a FLQuants

      ' signature(object=missing) '

     _c_a_t_c_h._q(_F_L_C_o_r_e) : Accessor method getting the FLCatch catch.q
          slots. Returns a FLQuants

      ' signature(object=missing) '

     _p_r_i_c_e(_F_L_C_o_r_e) : Accessor method getting the FLCatch price slots.
          Returns a FLQuants

      ' signature(object=missing) '

_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, landings, landings.n, landings.wt, price, FLlst-class,
     list

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

     # creation
     met1 <- FLMetier(name='met1',catches=FLCatches(FLCatch(name="spp1",
       landings.n=FLQuant(rnorm(100), dim=c(10,20)))))
     met2 <- FLMetier(name='met2',catches=FLCatches(FLCatch(name="spp1",
       landings.n=FLQuant(rnorm(100), dim=c(10,20))), FLCatch(name="spp2",
       landings.n=FLQuant(rnorm(100), dim=c(10,20)))))
     lst.metiers <- FLMetiers(met1=met1,met2=met2)

     # getter
     landings.n(met1,catch="spp1") # get a FLQuant
     landings.n(lst.metiers,catch="spp1") # get a FLQuants across metiers
     landings.n(lst.metiers,metier="met1") # get a FLQuants across species
     landings.n(lst.metiers,metier="met1",catch="spp1") # get a FLQuant

