FIMSRcppInterfaceBase Class Reference

Base class for all interface objects. More...

#include <rcpp_interface_base.hpp>

Inheritance diagram for FIMSRcppInterfaceBase:

Public Member Functions
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 parameter 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.

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

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

Detailed Description

Base class for all interface objects.

Member Function Documentation

add_to_fims_tmb()

virtual bool FIMSRcppInterfaceBase::add_to_fims_tmb ( )

inlinevirtual

A virtual method to inherit to add objects to the TMB model.

Reimplemented in DataInterfaceBase.

finalize()

virtual void FIMSRcppInterfaceBase::finalize ( )

inlinevirtual

Extracts derived quantities back to the Rcpp interface object from the Information object.

Reimplemented in DnormDistributionsInterface, DlnormDistributionsInterface, DmultinomDistributionsInterface, FleetInterface, LogisticMaturityInterface, CatchAtAgeInterface, PopulationInterface, BevertonHoltRecruitmentInterface, LogisticSelectivityInterface, and DoubleLogisticSelectivityInterface.

to_json()

virtual std::string FIMSRcppInterfaceBase::to_json ( )

inlinevirtual

Convert the data to json representation for the output.

Reimplemented in AgeCompDataInterface, LengthCompDataInterface, IndexDataInterface, LandingsDataInterface, DnormDistributionsInterface, DlnormDistributionsInterface, DmultinomDistributionsInterface, EWAAGrowthInterface, LogisticMaturityInterface, FisheryModelInterfaceBase, CatchAtAgeInterface, BevertonHoltRecruitmentInterface, LogisticSelectivityInterface, and DoubleLogisticSelectivityInterface.

value_to_string()

std::string FIMSRcppInterfaceBase::value_to_string ( double  value )

inline

Report the parameter value as a string.

Parameters

value

Returns

std::string

---

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

• inst/include/interface/rcpp/rcpp_objects/rcpp_interface_base.hpp