Files
AVSDevR.MarineNoiseRegistry/R/db.R
2026-02-10 17:54:17 +00:00

31 lines
887 B
R

#' MNR database queries base class
#'
#' @export
# nolint next: object_name_linter. R6Class
MNR.DB <- R6::R6Class(
"MNR.DB",
public = list(
#' @description Initialises the instance with a database client
#' \link[AVSDevR.DBClient]{DBClient}
#' @param db_client <\link[AVSDevR.DBClient]{DBClient}> A DBClient instance
initialize = function(db_client) {
if (is.null(db_client) || !inherits(db_client, "DBClient")) {
rlang::abort(
"db_client is not an instance of AVSDevR.DBClient::DBClient!"
)
}
private$db_client <- db_client
},
#' @description Returns the current DBClient instance in use
#' @returns <\link[AVSDevR.DBClient]{DBClient}> The DBClient instance used
#' by the class instance
getDBClient = function() {
private$db_client
}
),
private = list(
db_client = NULL
)
)