FLCatches-class: Class FLCatches

In FLCore: Core package of FLR, fisheries modelling in R.

Description

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.

Slots

.Data

The data. list.

names

Names of the list elements. character.

desc

Description of the object. character.

lock

Lock mechanism, if turned on the length of the list can not be modified by adding or removing elements. logical.

Extends

FLlst list

Constructor

The FLCatches(object) constructor method allows simple creation of new FLCatches with the methods described below.

signature(object=ANY) :

create a FLMetiers object from a set of FLMetier objects

signature(object=missing) :

create a FLMetiers object as a void list for future use

signature(object=list) :

create a FLMetiers object from a list of FLMetier objects

Methods

catch(FLCore) :

Accessor method for the catch slots. Returns an object of class FLQuants.

signature(object=FLCatches)

catch.n(FLCore) :

Accessor method for the catch.n slots. Returns an object of class FLQuants.

signature(object=FLCatches)

catch.wt(FLCore) :

Accessor method for the catch.wt slots. Returns an object of class FLQuants.

signature(object=FLCatches)

discards(FLCore) :

Accessor method for the discards slots. Returns an object of class FLQuants.

signature(object=FLCatches)

discards.n(FLCore) :

Accessor method for the discards.n slots. Returns an object of class FLQuants.

signature(object=FLCatches)

discards.wt(FLCore) :

Accessor method for the discards.wt slots. Returns an object of class FLQuants.

signature(object=FLCatches)

landings(FLCore) :

Accessor method for the landings slots. Returns an object of class FLQuants.

signature(object=FLCatches)

landings.n(FLCore) :

Accessor method for the landings.n slots. Returns an object of class FLQuants.

signature(object=FLCatches)

landings.wt(FLCore) :

Accessor method for the landings.wt slots. Returns an object of class FLQuants.

signature(object=FLCatches)

catch.q(FLCore) :

Accessor method for the catch.q slots. Returns an object of class FLQuants.

signature(object=FLCatches)

price(FLCore) :

Accessor method for the price slots. Returns an object of class FLQuants.

signature(object=FLCatches)

FLFleet(FLCore) :

Conversion method of a FLFleet object from a FLCatches object

signature(object=FLCatches)

FLMetier(FLCore) :

Conversion method of a FLMetier object from a FLCatches object

signature(catches=FLCatches)

Author(s)

The FLR Team

See Also

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

Examples

# 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

FLCore documentation built on May 2, 2019, 5:46 p.m.