implementation of #179

Author: Enchufa2

NAMESPACE

@@ -37,6 +37,8 @@ S3method(get_queue_size,wrap)
 S3method(get_queue_size_selected,simmer)
 S3method(get_resources,simmer)
 S3method(get_resources,wrap)
+S3method(get_seized,simmer)
+S3method(get_seized_selected,simmer)
 S3method(get_selected,simmer)
 S3method(get_server_count,simmer)
 S3method(get_server_count,wrap)
@@ -114,6 +116,8 @@ export(get_queue_count_selected)
 export(get_queue_size)
 export(get_queue_size_selected)
 export(get_resources)
+export(get_seized)
+export(get_seized_selected)
 export(get_selected)
 export(get_server_count)
 export(get_server_count_selected)

R/RcppExports.R

@@ -377,6 +377,14 @@ get_queue_count_selected_ <- function(sim_, id) {
     .Call(`_simmer_get_queue_count_selected_`, sim_, id)
 }
 
+get_seized_ <- function(sim_, names) {
+    .Call(`_simmer_get_seized_`, sim_, names)
+}
+
+get_seized_selected_ <- function(sim_, id) {
+    .Call(`_simmer_get_seized_selected_`, sim_, id)
+}
+
 get_selected_ <- function(sim_, id) {
     .Call(`_simmer_get_selected_`, sim_, id)
 }

R/simmer-class.R

@@ -287,6 +287,15 @@ Simmer <- R6Class("simmer",
       )
     },
 
+    get_seized = function(resources, id=0) {
+      check_args(resources=c("string vector", "NULL"), id="numeric")
+      ret <- switch(
+        binarise(is.null(resources)),
+        get_seized_(private$sim_obj, resources),
+        get_seized_selected_(private$sim_obj, id)
+      )
+    },
+
     get_selected = function(id=0) {
       check_args(id="numeric")
       get_selected_(private$sim_obj, id)

R/simmer-methods.R

@@ -40,13 +40,14 @@
 #' \code{\link{get_server_count}}, \code{\link{get_queue_count}},
 #' \code{\link{get_capacity_selected}}, \code{\link{get_queue_size_selected}},
 #' \code{\link{get_server_count_selected}}, \code{\link{get_queue_count_selected}},
+#' \code{\link{get_seized}}, \code{\link{get_seized_selected}},
 #' \code{\link{get_selected}}
 #'
 #' \item Sources: \code{\link{add_generator}}, \code{\link{add_dataframe}},
 #' \code{\link{get_sources}}, \code{\link{get_n_generated}},
 #' \code{\link{get_trajectory}}
 #'
-#' \item Globals: \code{\link{add_global}}, \code{\link{get_global}}.
+#' \item Globals: \code{\link{add_global}}, \code{\link{get_global}}
 #'
 #' \item Data retrieval: \code{\link{get_mon_arrivals}},
 #' \code{\link{get_mon_attributes}}, \code{\link{get_mon_resources}}
@@ -502,6 +503,20 @@ get_queue_count_selected <- function(.env, id=0) UseMethod("get_queue_count_sele
 #' @export
 get_queue_count_selected.simmer <- function(.env, id=0) .env$get_queue_count(NULL, id)
 
+#' @rdname get_capacity
+#' @export
+get_seized <- function(.env, resources) UseMethod("get_seized")
+
+#' @export
+get_seized.simmer <- function(.env, resources) .env$get_seized(resources)
+
+#' @rdname get_capacity
+#' @export
+get_seized_selected <- function(.env, id=0) UseMethod("get_seized_selected")
+
+#' @export
+get_seized_selected.simmer <- function(.env, id=0) .env$get_seized(NULL, id)
+
 #' @rdname get_capacity
 #' @export
 get_selected <- function(.env, id=0) UseMethod("get_selected")

man/get_capacity.Rd

@@ -1153,6 +1153,30 @@ BEGIN_RCPP
     return rcpp_result_gen;
 END_RCPP
 }
+// get_seized_
+std::vector<int> get_seized_(SEXP sim_, const std::vector<std::string>& names);
+RcppExport SEXP _simmer_get_seized_(SEXP sim_SEXP, SEXP namesSEXP) {
+BEGIN_RCPP
+    Rcpp::RObject rcpp_result_gen;
+    Rcpp::RNGScope rcpp_rngScope_gen;
+    Rcpp::traits::input_parameter< SEXP >::type sim_(sim_SEXP);
+    Rcpp::traits::input_parameter< const std::vector<std::string>& >::type names(namesSEXP);
+    rcpp_result_gen = Rcpp::wrap(get_seized_(sim_, names));
+    return rcpp_result_gen;
+END_RCPP
+}
+// get_seized_selected_
+std::vector<int> get_seized_selected_(SEXP sim_, int id);
+RcppExport SEXP _simmer_get_seized_selected_(SEXP sim_SEXP, SEXP idSEXP) {
+BEGIN_RCPP
+    Rcpp::RObject rcpp_result_gen;
+    Rcpp::RNGScope rcpp_rngScope_gen;
+    Rcpp::traits::input_parameter< SEXP >::type sim_(sim_SEXP);
+    Rcpp::traits::input_parameter< int >::type id(idSEXP);
+    rcpp_result_gen = Rcpp::wrap(get_seized_selected_(sim_, id));
+    return rcpp_result_gen;
+END_RCPP
+}
 // get_selected_
 std::vector<std::string> get_selected_(SEXP sim_, int id);
 RcppExport SEXP _simmer_get_selected_(SEXP sim_SEXP, SEXP idSEXP) {
@@ -1431,6 +1455,8 @@ static const R_CallMethodDef CallEntries[] = {
     {"_simmer_get_server_count_selected_", (DL_FUNC) &_simmer_get_server_count_selected_, 2},
     {"_simmer_get_queue_count_", (DL_FUNC) &_simmer_get_queue_count_, 2},
     {"_simmer_get_queue_count_selected_", (DL_FUNC) &_simmer_get_queue_count_selected_, 2},
+    {"_simmer_get_seized_", (DL_FUNC) &_simmer_get_seized_, 2},
+    {"_simmer_get_seized_selected_", (DL_FUNC) &_simmer_get_seized_selected_, 2},
     {"_simmer_get_selected_", (DL_FUNC) &_simmer_get_selected_, 2},
     {"_simmer_Simulator__new", (DL_FUNC) &_simmer_Simulator__new, 4},
     {"_simmer_reset_", (DL_FUNC) &_simmer_reset_, 1},

man/simmer.Rd

@@ -86,6 +86,18 @@ std::vector<int> get_queue_count_selected_(SEXP sim_, int id) {
   return get_param<int>(sim_, id, boost::mem_fn(&Resource::get_queue_count));
 }
 
+//[[Rcpp::export]]
+std::vector<int> get_seized_(SEXP sim_, const std::vector<std::string>& names) {
+  return get_param<int>(sim_, names, BIND(
+      &Resource::get_seized, _1, XPtr<Simulator>(sim_)->get_running_arrival()));
+}
+
+//[[Rcpp::export]]
+std::vector<int> get_seized_selected_(SEXP sim_, int id) {
+  return get_param<int>(sim_, id, BIND(
+      &Resource::get_seized, _1, XPtr<Simulator>(sim_)->get_running_arrival()));
+}
+
 std::string get_name(Resource* res) { return res->name; }
 
 //[[Rcpp::export]]