R/get-generics.R

In UBESP-DCTV/clumpr: Current transpLant sUrplus Management Protocol in R

#' Get the centers name
#'
#' This is a generic function aimed to access to the \code{center} name of a
#' center.
#'
#' @param x an object used to select a method.
#' @param ... further arguments passed to or from other methods.
#'
#' @return The \code{center} name for the object \code{x}.
#' @export
get_center <- function(x, ...) {
  UseMethod("get_center")
}

#' Get the centers details
#'
#' This is a generic function aimed to access to the \code{centers} details
#' of an object.
#'
#' @param x an object used to select a method.
#' @param ... further arguments passed to or from other methods.
#'
#' @return The \code{centers} details for the object \code{x}.
#' @export
get_centers <- function(x, ...) {
  UseMethod("get_centers")
}


#' Get the region name
#'
#' This is a generic function aimed to access to the region name of an
#' object
#'
#' @param x an object used to select a method.
#' @param ... further arguments passed to or from other methods.
#'
#' @return The region name for the object \code{x}.
#'
#' @export
get_region <- function(x, ...) {
  UseMethod("get_region")
}

#' Get the all included regions' name
#'
#' This is a generic function aimed to access to the all the regions' name
#' into an object
#'
#' @param x an object used to select a method.
#' @param ... further arguments passed to or from other methods.
#'
#' @return The regions' name for the object \code{x}.
#'
#' @export
get_all_region <- function(x, ...) {
  UseMethod("get_all_region")
}

#' Get the regions details
#'
#' This is a generic function aimed to access to the \code{regions} details
#' of an object.
#'
#' @param x an object used to select a method.
#' @param ... further arguments passed to or from other methods.
#'
#' @return The \code{regions} details for the object \code{x}.
#' @export
get_regions <- function(x, ...) {
  UseMethod("get_regions")
}


#' Get the macroregions details
#'
#' This is a generic function aimed to access to the \code{macroregions}
#' details of an object
#'
#' @param x an object used to select a method.
#' @param ... further arguments passed to or from other methods.
#'
#' @return The \code{macroregions} details for the object \code{x}.
#'
#' @export
get_macroregions <- function(x, ...) {
  UseMethod("get_macroregions")
}

#' Get all the macroregions' names
#'
#' This is a generic function aimed to access to the \code{macroregions}
#' names of an object
#'
#' @param x an object used to select a method.
#' @param ... further arguments passed to or from other methods.
#'
#' @return The \code{macroregions}' name for the object \code{x}.
#'
#' @export
get_all_macroregion <- function(x, ...) {
  UseMethod("get_all_macroregion")
}


#' Get the macroareas details
#'
#' This is a generic function aimed to access to the \code{macroareas}
#' details of an object
#'
#' @param x an object used to select a method.
#' @param ... further arguments passed to or from other methods.
#'
#' @return The \code{macroareas} details for the object \code{x}.
#'
#' @export
get_macroareas <- function(x, ...) {
  UseMethod("get_macroareas")
}

#' Get all the macroareas' name
#'
#' This is a generic function aimed to access to the \code{macroareas}
#' names of an object
#'
#' @param x an object used to select a method.
#' @param ... further arguments passed to or from other methods.
#'
#' @return The \code{macroareas} names for the object \code{x}.
#'
#' @export
get_all_macroarea <- function(x, ...) {
  UseMethod("get_all_macroarea")
}


#' Get the state details
#'
#' This is a generic function aimed to access to the state details of an
#' object.
#'
#' @param x an object used to select a method.
#' @param ... further arguments passed to or from other methods.
#'
#' @return The state details for the object \code{x}.
#' @export
get_state <- function(x, ...) {
  UseMethod("get_state")
}


#' Get the probability of acceptance
#'
#' This is a generic function aimed to access (or compute) to the
#' probability of acceptance (for an offered organ) details of an object
#'
#' @param x an object used to select a method.
#' @param ... further arguments passed to or from other methods.
#'
#' @return The probability of acceptance for the object \code{x}.
#' @export
get_p_accept <- function(x, ...) {
  UseMethod("get_p_accept")
}


#' Get the probability of acceptance exept for a given center
#'
#' This is a generic function aimed to access (or compute) to the
#' probability of acceptance (for an offered organ) by an area
#' excluding the (macro-)region how have offered the organ.
#'
#' @param macroarea an object used to select a method.
#' @param offering_region a region name into the area
#' @param ... further arguments passed to or from other methods.
#'
#' @return The probability of acceptance for the \code{macroarea} don't
#'         considering the \code{offering_region}.
#' @export
get_p_except_for <- function(macroarea, offering_region) {
  UseMethod("get_p_except_for")
}



#' Get number of offered organs
#'
#' This is a generic function aimed to access (or compute) to the
#' number of offered organs of a center, region, ...
#'
#' @param x an object used to select a method.
#' @param ... further arguments passed to or from other methods.
#'
#' @return The number of offered organs for the object \code{x}.
#' @export
get_offered <- function(x, ...) {
  UseMethod("get_offered")
}

#' Get the default probability of acceptance for a region
#'
#' This is a generic function aimed to access to the default probability
#' attributes of acceptance (for an offered organ) of an object
#'
#' @param x an object used to select a method.
#' @param ... further arguments passed to or from other methods.
#'
#' @return The probability of acceptance for the object \code{x}.
#' @export
get_p_default <- function(x, ...) {
  UseMethod("get_p_default")
}

#' Get the initial strip details
#'
#' This is a generic function aimed to access to the \code{initial_strip}
#' details of an object.
#'
#' @param x an object used to select a method.
#' @param ... further arguments passed to or from other methods.
#'
#' @return The \code{initial_strip} details for the object \code{x}.
#' @export
get_initial_strip <- function(x, ...) {
  UseMethod("get_initial_strip")
}


#' Get the current strip details
#'
#' This is a generic function aimed to access to the \code{current_strip}
#' details of an object.
#'
#' @param x an object used to select a method.
#' @param ... further arguments passed to or from other methods.
#'
#' @return The \code{current_strip} details for the object \code{x}.
#' @export
get_current_strip <- function(x, ...) {
  UseMethod("get_current_strip")
}

#' Get the initial time details
#'
#' This is a generic function aimed to access to the \code{initial_time}
#' details of an object.
#'
#' @param x an object used to select a method.
#' @param ... further arguments passed to or from other methods.
#'
#' @return The \code{initial_time} details for the object \code{x}.
#' @export
get_initial_time <- function(x, ...) {
  UseMethod("get_initial_time")
}

#' Get the current time details
#'
#' This is a generic function aimed to access to the \code{current_time}
#' details of an object.
#'
#' @param x an object used to select a method.
#' @param ... further arguments passed to or from other methods.
#'
#' @return The \code{current_time} details for the object \code{x}.
#' @export
get_time <- function(x, ...) {
  UseMethod("get_time")
}

#' Get the final time details
#'
#' This is a generic function aimed to access to the \code{final_time}
#' details of an object.
#'
#' @param x an object used to select a method.
#' @param ... further arguments passed to or from other methods.
#'
#' @return The \code{final_time} details for the object \code{x}.
#' @export
get_final_time <- function(x, ...) {
  UseMethod("get_final_time")
}