R/elementarywellplan.R

#' @name elementarywellplan
#' @title R6 class elementarywellplan
#' @description Create R6 reference object class elementarywellplan
#' @importFrom R6 R6Class
# elementarywellplan ----
elementarywellplan <- R6::R6Class(classname = "elementarywellplan",
                                  public = list(
                                    # initialize ----
                                    #' @description Initialize function for R6 elementarywellplan class.
                                    #' @param wellplan_id Object of class {\link[base]{character}} expected. Wellplan identification.
                                    #' @param well_id Object of class {\link[base]{character}} expected. Well identification.
                                    #' @param activity_id Object of class {\link[base]{character}} expected. Activity identification.
                                    #' @param sample_id Object of class {\link[base]{character}} expected. Sample identification.
                                    #' @param specie_code Object of class {\link[base]{integer}} expected. Specie code identifiation.
                                    #' @param specie_code3l Object of class {\link[base]{character}} expected. Specie code identification on 3 characters.
                                    #' @param wellplan_weight (numeric) Weight in tonnes filled in the well plan.
                                    #' @param wellplan_number Object of class {\link[base]{integer}} expected. Well plan number of individus.
                                    #' @param wellplan_weigth_category_code Object of class {\link[base]{integer}} expected. Well plan category code identification.
                                    #' @param wellplan_weigth_category_label Object of class {\link[base]{character}} expected. Well plan weight category identification.
                                    initialize = function(wellplan_id,
                                                          well_id,
                                                          activity_id,
                                                          sample_id,
                                                          specie_code,
                                                          specie_code3l,
                                                          wellplan_weight,
                                                          wellplan_number,
                                                          wellplan_weigth_category_code,
                                                          wellplan_weigth_category_label) {
                                      # attribute "wellplan_id" verification
                                      check_wellplan_id(wellplan_id)
                                      # attribute "well_id" verification
                                      check_well_id(well_id)
                                      # attribute "activity_id" verification
                                      check_activity_id(activity_id)
                                      # attribute "sample_id" verification
                                      check_sample_id(sample_id)
                                      # attribute "specie_code" verification
                                      check_specie_code(specie_code)
                                      # attribute "specie_code3l" verification
                                      check_specie_code3l(specie_code3l)
                                      # attribute "wellplan_weight" verification
                                      check_wellplan_weight(wellplan_weight)
                                      # attribute "wellplan_number" verification
                                      check_wellplan_number(wellplan_number)
                                      # attribute "wellplan_weigth_category_code" verification
                                      check_wellplan_weigth_category_code(wellplan_weigth_category_code)
                                      # attribute "wellplan_weigth_category_label" verification
                                      check_wellplan_weigth_category_label(wellplan_weigth_category_label)
                                      # attributions
                                      private$wellplan_id <- wellplan_id
                                      private$well_id <- well_id
                                      private$activity_id <- activity_id
                                      private$sample_id <- sample_id
                                      private$specie_code <- specie_code
                                      private$specie_code3l <- specie_code3l
                                      private$wellplan_weight <- wellplan_weight
                                      private$wellplan_number <- wellplan_number
                                      private$wellplan_weigth_category_code <- wellplan_weigth_category_code
                                      private$wellplan_weigth_category_label <- wellplan_weigth_category_label}),
                                  private = list(
                                    wellplan_id = NULL,
                                    well_id = NULL,
                                    activity_id = NULL,
                                    sample_id = NULL,
                                    specie_code = NULL,
                                    specie_code3l = NULL,
                                    wellplan_weight = NULL,
                                    wellplan_number = NULL,
                                    wellplan_weigth_category_code = NULL,
                                    wellplan_weigth_category_label = NULL))
OB7-IRD/t3 documentation built on May 11, 2024, 7:02 a.m.