FIMS  v0.8.0
Loading...
Searching...
No Matches
fims_popdy::UncertaintyReportInfo Struct Reference

#include <fishery_model_base.hpp>

Public Member Functions

 UncertaintyReportInfo ()
 Default constructor for UncertaintyReportInfo.
 
 UncertaintyReportInfo (const std::string &name, uint32_t id, size_t start, size_t length)
 Constructor with parameters.
 
 UncertaintyReportInfo (const UncertaintyReportInfo &other)
 Copy constructor.
 

Public Attributes

std::string name
 
uint32_t id_m
 
size_t start_m
 
size_t length_m
 

Detailed Description

TMB sdreport values are returned as a single vector, if there are multiple populations or fleets then the report vectors are concatenated together. This struct is used to store the name, id, and length of each report vector so that they can be extracted from the single report vector.

Constructor & Destructor Documentation

◆ UncertaintyReportInfo() [1/2]

fims_popdy::UncertaintyReportInfo::UncertaintyReportInfo ( const std::string &  name,
uint32_t  id,
size_t  start,
size_t  length 
)
inline

Constructor with parameters.

Parameters
nameThe name of the report vector.
idThe id of the population or fleet the report is associated with.
startThe starting index of the report vector in the overall report vector.
lengthThe length of the report vector.

◆ UncertaintyReportInfo() [2/2]

fims_popdy::UncertaintyReportInfo::UncertaintyReportInfo ( const UncertaintyReportInfo other)
inline

Copy constructor.

Parameters
otherThe UncertaintyReportInfo object to copy from.

Member Data Documentation

◆ id_m

uint32_t fims_popdy::UncertaintyReportInfo::id_m
  • id of the population or fleet the report is associated with

◆ length_m

size_t fims_popdy::UncertaintyReportInfo::length_m
  • length of the report vector

◆ name

std::string fims_popdy::UncertaintyReportInfo::name
  • name of the report vector

◆ start_m

size_t fims_popdy::UncertaintyReportInfo::start_m
  • starting index of the report vector in the overall report vector

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