DataInterfaceBase Class Reference

Rcpp interface that serves as the parent class for Rcpp data interfaces. This type should be inherited and not called from R directly. More...

#include <rcpp_data.hpp>

Inheritance diagram for DataInterfaceBase:

Public Member Functions
	DataInterfaceBase ()
	The constructor.
	DataInterfaceBase (const DataInterfaceBase &other)
	Construct a new Data Interface Base object.
virtual	~DataInterfaceBase ()
	The destructor.
virtual uint32_t	get_id ()
	Get the ID for the child data interface objects to inherit.
virtual bool	add_to_fims_tmb ()
	Adds the parameters to the TMB model.
Public Member Functions inherited from FIMSRcppInterfaceBase
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.

Public Attributes
Rcpp::NumericVector	observed_data
	The vector of data that is being passed from R.
Rcpp::NumericVector	uncertainty
	The vector of uncertainty that is being passed from R.
uint32_t	id
	The local id of the DataInterfaceBase object.
Public Attributes inherited from FIMSRcppInterfaceBase
bool	finalized = false
	Is the object already finalized? The default is false.

Static Public Attributes
static std::map< uint32_t, std::shared_ptr< DataInterfaceBase > >	live_objects
	The map associating the IDs of DataInterfaceBase 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 that serves as the parent class for Rcpp data interfaces. This type should be inherited and not called from R directly.

Constructor & Destructor Documentation

DataInterfaceBase()

DataInterfaceBase::DataInterfaceBase ( const DataInterfaceBase & other )

inline

Construct a new Data Interface Base object.

Parameters

other

Member Function Documentation

add_to_fims_tmb()

virtual bool DataInterfaceBase::add_to_fims_tmb ( )

inlinevirtual

Adds the parameters to the TMB model.

Reimplemented from FIMSRcppInterfaceBase.

get_id()

virtual uint32_t DataInterfaceBase::get_id ( )

inlinevirtual

Get the ID for the child data interface objects to inherit.

Reimplemented in AgeCompDataInterface, CatchDataInterface, IndexDataInterface, and LengthCompDataInterface.

---

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

• inst/include/interface/rcpp/rcpp_objects/rcpp_data.hpp
• src/rcpp_data.cpp