Rcpp interface base for growth models that can register a growth-derived observation capability with the runtime model. More...

#include <rcpp_growth.hpp>

Inheritance diagram for GrowthDerivedObservationInterfaceBase:

Public Member Functions
	GrowthDerivedObservationInterfaceBase (const GrowthDerivedObservationInterfaceBase &other)
	Copy constructor.

Public Member Functions inherited from GrowthInterfaceBase
	GrowthInterfaceBase ()
	The constructor.

	GrowthInterfaceBase (const GrowthInterfaceBase &other)
	Construct a new Growth Interface Base object.

virtual	~GrowthInterfaceBase ()
	The destructor.

virtual uint32_t	get_id ()=0
	Get the ID for the child growth interface objects to inherit.

virtual double	evaluate (double age)=0
	A method for each child growth interface object to inherit so each growth option can have an evaluate() function.

Public Member Functions inherited from FIMSRcppInterfaceBase
virtual bool	add_to_fims_tmb ()
	A virtual method to inherit to add objects to the TMB model.

virtual void	finalize ()
	Extracts derived quantities back to the Rcpp interface object from the Information object.

virtual std::string	to_json ()
	Convert the data to json representation for the output.

std::string	value_to_string (double value)
	Report the variable value as a string.

std::string	make_dimensions (uint32_t start, uint32_t end, uint32_t rep=1)
	Make a string of dimensions for the model.

Protected Member Functions
template<typename Type >
std::shared_ptr< fims_popdy::GrowthDerivedObservationBase< Type > >	GetGrowthObservationFromInfo () const
	Look up the registered growth-derived observation object.

template<typename Type >
void	RegisterGrowthObservationInInfo (const std::shared_ptr< fims_popdy::GrowthDerivedObservationBase< Type > > &growth_observation) const
	Register a runtime growth-derived observation in Information.

Additional Inherited Members
Public Attributes inherited from GrowthInterfaceBase
uint32_t	id
	The local id of the GrowthInterfaceBase object.

Public Attributes inherited from FIMSRcppInterfaceBase
bool	finalized = false
	Is the object already finalized? The default is false.

Static Public Attributes inherited from GrowthInterfaceBase
static uint32_t	id_g = 1
	The static id of the GrowthInterfaceBase object.

static std::map< uint32_t, std::shared_ptr< GrowthInterfaceBase > >	live_objects
	The map associating the IDs of GrowthInterfaceBase to the objects. This is a live object, which is an object that has been created and lives in memory.

Static Public Attributes inherited from FIMSRcppInterfaceBase
static std::vector< std::shared_ptr< FIMSRcppInterfaceBase > >	fims_interface_objects
	FIMS interface object vectors.

Detailed Description

Rcpp interface base for growth models that can register a growth-derived observation capability with the runtime model.

This keeps the Rcpp producer side aligned with the generic GrowthDerivedObservationBase contract used by catch-at-age while still allowing concrete interfaces to manage their own model-specific parameters.

Constructor & Destructor Documentation

◆ GrowthDerivedObservationInterfaceBase()

GrowthDerivedObservationInterfaceBase::GrowthDerivedObservationInterfaceBase ( const GrowthDerivedObservationInterfaceBase & other )

inline

Copy constructor.

Parameters

other Source interface object.

Member Function Documentation

◆ GetGrowthObservationFromInfo()

template<typename Type >

std::shared_ptr< fims_popdy::GrowthDerivedObservationBase< Type > > GrowthDerivedObservationInterfaceBase::GetGrowthObservationFromInfo ( ) const

inlineprotected

Look up the registered growth-derived observation object.

Returns: Shared pointer to the registered runtime growth object, or null.

◆ RegisterGrowthObservationInInfo()

template<typename Type >

void GrowthDerivedObservationInterfaceBase::RegisterGrowthObservationInInfo ( const std::shared_ptr< fims_popdy::GrowthDerivedObservationBase< Type > > & growth_observation ) const

inlineprotected

Register a runtime growth-derived observation in Information.

Parameters

growth_observation Runtime growth object to register.

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

inst/include/interface/rcpp/rcpp_objects/rcpp_growth.hpp

Public Member Functions