fims_model_object::FIMSObject< Type > Struct Template Reference

FIMSObject struct that defines member types and returns the unique id. More...

#include <model_object.hpp>

Inheritance diagram for fims_model_object::FIMSObject< Type >:

Public Member Functions
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.
virtual void	create_report_vectors (std::map< std::string, fims::Vector< fims::Vector< Type > > > &report_vectors)
	Create a map of report vectors for the object. used to populate the report_vectors map in FisheryModelBase.
virtual void	get_report_vector_count (std::map< std::string, size_t > &report_vector_count)
	Get the report vector count object. used to get the length of each report vector for populating the UncertaintyReportInfo struct in FisheryModelBase.

Public Attributes
uint32_t	id
std::vector< Type * >	parameters
std::vector< Type * >	random_effects_parameters
std::vector< Type * >	fixed_effects_parameters

Detailed Description

template<typename Type>
struct fims_model_object::FIMSObject< Type >

FIMSObject struct that defines member types and returns the unique id.

Member Function Documentation

CheckDimensions()

template<typename Type >

bool fims_model_object::FIMSObject< Type >::CheckDimensions ( size_t  actual, size_t  expected  )

inline

Check the dimensions of an object.

Parameters

actual	The actual dimensions.
expected	The expected dimensions.

Returns

true

false

create_report_vectors()

template<typename Type >

virtual void fims_model_object::FIMSObject< 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. used to populate the report_vectors map in FisheryModelBase.

Reimplemented in fims_popdy::Fleet< Type >, fims_popdy::EWAAGrowth< Type >, fims_popdy::LogisticMaturity< Type >, fims_popdy::Population< Type >, fims_popdy::SRBevertonHolt< Type >, fims_popdy::DoubleLogisticSelectivity< Type >, and fims_popdy::LogisticSelectivity< Type >.

get_report_vector_count()

template<typename Type >

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

inlinevirtual

Get the report vector count object. used to get the length of each report vector for populating the UncertaintyReportInfo struct in FisheryModelBase.

Reimplemented in fims_popdy::Fleet< Type >, fims_popdy::LogisticMaturity< Type >, fims_popdy::Population< Type >, fims_popdy::SRBevertonHolt< Type >, fims_popdy::DoubleLogisticSelectivity< Type >, and fims_popdy::LogisticSelectivity< Type >.

Member Data Documentation

fixed_effects_parameters

template<typename Type >

std::vector<Type*> fims_model_object::FIMSObject< Type >::fixed_effects_parameters

list of fixed effects parameters

id

template<typename Type >

uint32_t fims_model_object::FIMSObject< Type >::id

unique identifier assigned for all fims objects

parameters

template<typename Type >

std::vector<Type*> fims_model_object::FIMSObject< Type >::parameters

list of estimable parameters

random_effects_parameters

template<typename Type >

std::vector<Type*> fims_model_object::FIMSObject< Type >::random_effects_parameters

list of all random effects parameters

---

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

• inst/include/common/model_object.hpp