fims_popdy::Fleet< Type > Struct Template Reference

Base class for all fleets. More...

#include <fleet.hpp>

Inheritance diagram for fims_popdy::Fleet< Type >:

Public Member Functions
	Fleet ()
	Constructor.
virtual	~Fleet ()
	Destructor.
void	Prepare ()
	Prepare to run the fleet module. Called at each model iteration, and used to exponentiate the natural log of q and Fmort parameters prior to evaluation.
virtual void	create_report_vectors (std::map< std::string, fims::Vector< fims::Vector< Type > > > &report_vectors)
virtual void	get_report_vector_count (std::map< std::string, size_t > &report_vector_count)
Public Member Functions inherited from fims_model_object::FIMSObject< Type >
uint32_t	GetId () const
	Getter that returns the unique id for parameters in the model.
bool	CheckDimensions (size_t actual, size_t expected)
	Check the dimensions of an object.

Public Attributes
size_t	n_years
size_t	n_ages
size_t	n_lengths
int	fleet_selectivity_id_m = -999
std::shared_ptr< SelectivityBase< Type > >	selectivity
int	fleet_observed_landings_data_id_m = -999
std::shared_ptr< fims_data_object::DataObject< Type > >	observed_landings_data
std::string	observed_landings_units
int	fleet_observed_index_data_id_m = -999
std::shared_ptr< fims_data_object::DataObject< Type > >	observed_index_data
std::string	observed_index_units
int	fleet_observed_agecomp_data_id_m = -999
std::shared_ptr< fims_data_object::DataObject< Type > >	observed_agecomp_data
int	fleet_observed_lengthcomp_data_id_m = -999
std::shared_ptr< fims_data_object::DataObject< Type > >	observed_lengthcomp_data
fims::Vector< Type >	log_Fmort
fims::Vector< Type >	log_q
fims::Vector< Type >	Fmort
fims::Vector< Type >	q
fims::Vector< Type >	age_to_length_conversion
Public Attributes inherited from fims_model_object::FIMSObject< Type >
uint32_t	id
std::vector< Type * >	parameters
std::vector< Type * >	random_effects_parameters
std::vector< Type * >	fixed_effects_parameters

Static Public Attributes
static uint32_t	id_g = 0

Detailed Description

template<class Type>
struct fims_popdy::Fleet< Type >

Base class for all fleets.

Template Parameters

Type	The type of the fleet object.

Member Function Documentation

create_report_vectors()

template<class Type >

virtual void fims_popdy::Fleet< Type >::create_report_vectors ( std::map< std::string, fims::Vector< fims::Vector< Type > > > &  report_vectors )

inlinevirtual

Create a map of report vectors for the object.

Reimplemented from fims_model_object::FIMSObject< Type >.

get_report_vector_count()

template<class Type >

virtual void fims_popdy::Fleet< Type >::get_report_vector_count ( std::map< std::string, size_t > &  report_vector_count )

inlinevirtual

Get the report vector count object.

Reimplemented from fims_model_object::FIMSObject< Type >.

Member Data Documentation

age_to_length_conversion

template<class Type >

fims::Vector<Type> fims_popdy::Fleet< Type >::age_to_length_conversion

derived quantity age to length conversion matrix

fleet_observed_agecomp_data_id_m

template<class Type >

int fims_popdy::Fleet< Type >::fleet_observed_agecomp_data_id_m = -999

id of age comp data

fleet_observed_index_data_id_m

template<class Type >

int fims_popdy::Fleet< Type >::fleet_observed_index_data_id_m = -999

id of index data

fleet_observed_landings_data_id_m

template<class Type >

int fims_popdy::Fleet< Type >::fleet_observed_landings_data_id_m = -999

id of landings data

fleet_observed_lengthcomp_data_id_m

template<class Type >

int fims_popdy::Fleet< Type >::fleet_observed_lengthcomp_data_id_m = -999

id of length comp data

fleet_selectivity_id_m

template<class Type >

int fims_popdy::Fleet< Type >::fleet_selectivity_id_m = -999

id of selectivity component

Fmort

template<class Type >

fims::Vector<Type> fims_popdy::Fleet< Type >::Fmort

transformed parameter: Fishing mortality

id_g

template<class Type >

uint32_t fims_popdy::Fleet< Type >::id_g = 0

static

reference id for fleet object

log_Fmort

template<class Type >

fims::Vector<Type> fims_popdy::Fleet< Type >::log_Fmort

estimated parameter: log Fishing mortality

log_q

template<class Type >

fims::Vector<Type> fims_popdy::Fleet< Type >::log_q

estimated parameter: catchability of the fleet

n_ages

template<class Type >

size_t fims_popdy::Fleet< Type >::n_ages

the number of ages in the model

n_lengths

template<class Type >

size_t fims_popdy::Fleet< Type >::n_lengths

the number of lengths in the model

n_years

template<class Type >

size_t fims_popdy::Fleet< Type >::n_years

the number of years in the model

observed_agecomp_data

template<class Type >

std::shared_ptr<fims_data_object::DataObject<Type> > fims_popdy::Fleet< Type >::observed_agecomp_data

observed agecomp data

observed_index_data

template<class Type >

std::shared_ptr<fims_data_object::DataObject<Type> > fims_popdy::Fleet< Type >::observed_index_data

observed index data

observed_index_units

template<class Type >

std::string fims_popdy::Fleet< Type >::observed_index_units

is this fleet index in weight

observed_landings_data

template<class Type >

std::shared_ptr<fims_data_object::DataObject<Type> > fims_popdy::Fleet< Type >::observed_landings_data

observed landings data

observed_landings_units

template<class Type >

std::string fims_popdy::Fleet< Type >::observed_landings_units

is this fleet landings in weight

observed_lengthcomp_data

template<class Type >

std::shared_ptr<fims_data_object::DataObject<Type> > fims_popdy::Fleet< Type >::observed_lengthcomp_data

observed lengthcomp data

q

template<class Type >

fims::Vector<Type> fims_popdy::Fleet< Type >::q

transformed parameter: the catchability of the fleet

selectivity

template<class Type >

std::shared_ptr<SelectivityBase<Type> > fims_popdy::Fleet< Type >::selectivity

selectivity component

---

The documentation for this struct was generated from the following file:

• inst/include/population_dynamics/fleet/fleet.hpp