The Rcpp interface for LengthComp to instantiate the object from R: lcomp <- methods::new(LengthComp). More...

Inheritance diagram for LengthCompDataInterface:

Public Member Functions
	LengthCompDataInterface (int ymax=0, int lmax=0)
	The constructor.

	LengthCompDataInterface (const LengthCompDataInterface &other)
	Construct a new Length Comp Data Interface object.

virtual	~LengthCompDataInterface ()
	The destructor.

virtual uint32_t	get_id ()
	Gets the ID of the interface base object.

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

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

	DataInterfaceBase (const DataInterfaceBase &other)
	Construct a new Data Interface Base object.

virtual	~DataInterfaceBase ()
	The destructor.

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.

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
fims_int	lmax = 0
	The first dimension of the data, which relates to the number of length bins.

fims_int	ymax = 0
	The second dimension of the data, which relates to the number of time steps or years.

RealVector	length_comp_data
	The vector of length-composition data that is being passed from R.

RealVector	uncertainty
	The vector of length-composition uncertainty that is being passed from R.

Public Attributes inherited from DataInterfaceBase
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.

Additional Inherited Members
Static Public Attributes inherited from DataInterfaceBase
static uint32_t	id_g = 1
	The static id of the DataInterfaceBase object.

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

The Rcpp interface for LengthComp to instantiate the object from R: lcomp <- methods::new(LengthComp).

Constructor & Destructor Documentation

LengthCompDataInterface::LengthCompDataInterface ( const LengthCompDataInterface & other )

inline

Construct a new Length Comp Data Interface object.

Parameters

other

virtual uint32_t LengthCompDataInterface::get_id ( )

inlinevirtual

Gets the ID of the interface base object.

Reimplemented from DataInterfaceBase.

virtual std::string LengthCompDataInterface::to_json ( )

inlinevirtual

Converts the data to json representation for the output.

Returns: A string is returned specifying that the module relates to the data interface with length-composition data. It also returns the ID, the rank of 2, the dimensions by printing ymax and lmax, followed by the data values themselves. This string is formatted for a json file.

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