FLMetier-class            package:FLCore            R Documentation

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

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

     The 'FLMetier' class is an internal class of FLFleet storing all 
     information related to the activity of a fleet in a specific
     metier. A metier refers typically to a particular type of activity
     described by e.g. a specific gear and/or mesh  size range and/or
     target species and/or spatio-temporal distribution etc. The
     underlying  use of the FLMetier class is to distinguish between
     several types of activities within the  same fleet unit.

     The 'FLMetier' class can contain information about gear used,
     share of the effort of the fleet in that metier, variable costs,
     as well as catch information. Catches data are    stored in a
     'FLCatches' object, which is a list of 'FLCatch' objects. Each of 
     them stores stock or species specific information such as
     landings, discards and catches,  catchability and price.

     A number of accessors are defined for 'FLMetier', allowing to
     extract directly  specific slots both from the 'FLMetier' class
     and to the 'FLCatch' objects it  contains. If catch is specified
     in those, it returns the FLQuant corresponding to the  FLCatch
     object of that name. If catch is missing, it returns a FLQuants
     object for all  stocks of the 'FLCatches' object. Corresponding
     replacement methods for these slots  exist for the FLQuant objects
     but not for the FLQuants objects, due to possible  differences of
     dimensions across FLCatch objects.

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


     _g_e_a_r Name of the gear. 'character'.

     _e_f_f_s_h_a_r_e Proportion of the total effort of the fleet allocated to
          this metier. effshare must not be higher than 1, and the sums
          of effshare across all  metiers within a fleet should be
          equal to or lower than 1. 'FLQuant'.

     _v_c_o_s_t Variable costs per unit of effort.  'FLQuant'.

     _c_a_t_c_h_e_s List of 'FLCatch' objects containing catch information by
          stock or species. 'FLCatches'.

     _n_a_m_e Name of the object.  'character'.

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

     _r_a_n_g_e ('numeric') Named vector containing the dimensions of the
          object

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


          FLComp

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


     _c_a_t_c_h(_F_L_C_o_r_e) : Accessor method for the catch slot for a given
          FLCatch or across the FLCatches objects  

      ' signature(object=missing) '

     _c_a_t_c_h._n(_F_L_C_o_r_e) : Accessor method for the catch.n slot for a given
          FLCatch or across the FLCatches objects

      ' signature(object=missing) '

     _c_a_t_c_h._q(_F_L_C_o_r_e) : Accessor method for the catch.q slot for a given
          FLCatch or across the FLCatches objects

      ' signature(object=missing) '

     _c_a_t_c_h._s_e_l(_F_L_C_o_r_e) : Accessor method for the catch.sel slot for a
          given FLCatch or across the FLCatches objects

      ' signature(object=missing) '

     _c_a_t_c_h._w_t(_F_L_C_o_r_e) : Accessor method for the catch.wt slot for a
          given FLCatch or across the FLCatches objects

      ' signature(object=missing) '

     _d_i_s_c_a_r_d_s(_F_L_C_o_r_e) : Accessor method for the discards slot for a
          given FLCatch or across the FLCatches objects

      ' signature(object=missing) '

     _d_i_s_c_a_r_d_s._n(_F_L_C_o_r_e) : Accessor method for the discards.n slot for a
          given  FLCatch or across the FLCatches objects

      ' signature(object=missing) '

     _d_i_s_c_a_r_d_s._s_e_l(_F_L_C_o_r_e) : Accessor method for the discards.sel slot
          for a given   FLCatch or across the FLCatches objects

      ' signature(object=missing) '

     _d_i_s_c_a_r_d_s._w_t(_F_L_C_o_r_e) : Accessor method for the discards.wt slot for
          a given  FLCatch or across the FLCatches objects

      ' signature(object=missing) '

     _F_L_F_l_e_e_t(_F_L_C_o_r_e) : Describe method

      ' signature(object=missing) '

     _l_a_n_d_i_n_g_s(_F_L_C_o_r_e) : Accessor method for the landings slot for a
          given FLCatch or across the FLCatches objects

      ' signature(object=missing) '

     _l_a_n_d_i_n_g_s._n(_F_L_C_o_r_e) : Accessor method for the landings.n slot for a
          given   FLCatch or across the FLCatches objects

      ' signature(object=missing) '

     _l_a_n_d_i_n_g_s._s_e_l(_F_L_C_o_r_e) : Accessor method for the landings.sel slot
          for a given  FLCatch or across the FLCatches objects

      ' signature(object=missing) '

     _l_a_n_d_i_n_g_s._w_t(_F_L_C_o_r_e) : Accessor method for the landings.wt slot for
          a given  FLCatch or across the FLCatches objects

      ' signature(object=missing) '

     _p_r_i_c_e(_F_L_C_o_r_e) : Accessor method for the price slot for a given
          FLCatch or across the FLCatches objects

      ' signature(object=missing) '

     _F_L_F_l_e_e_t(_F_L_C_o_r_e) : creates a FLFleet object from a FLMetier object.
          All other FLFleet slots are set to NA.  

      'signature(object=missing)'

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

     The FLR Team

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

     catch, catch.n, catch.q, catch.sel, catch.wt, discards,
     discards.n, discards.sel, discards.wt, FLFleet, landings,
     landings.n, landings.sel, landings.wt, price, FLComp

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

     data(bt4)
     mymetier<-metier(bt4, "TBB")
     summary(mymetier)

     catch(mymetier) #returns a FLQuants object
     catch(mymetier, "ple") #returns a FLQuant object

