R/pdmp_accessors.R

In CharlotteJana/pdmpsim: Simulate Piecewise Deterministic Markov Processes

#======== todo =================================================================
#t2 simecol slot "inputs" importieren?
#t2 auch ... einfügen wie in simecol accessors (siehe ?parms)
#t3 wenn discStates geändert, verify aufrufen

#======== Description ===========

#' Accessor functions for Class pdmpModel
#'
#' Get or set the slot values for an object of class \code{\link{pdmpModel}}. 
#' In most cases, setting a new value also affects the slot \code{out} 
#' (where the simulation result can be stored). This applies to slots 
#' \code{times}, \code{parms}, \code{init}, \code{dynfunc}, \code{ratefunc},
#' \code{jumpfunc}, \code{discStates} and \code{initfunc}, which set out to 
#' NULL. Setting a new value for \code{descr} will not affect 
#' the slot \code{out}.
#' 
#' It is also possible to modify the slots directly,
#' e.g. the parameters of a model \code{pdmp} with \code{pdmp@parms}, 
#' but this is normally not recommended as there is no guarantee that this 
#' will work in a compatible way in future versions.
#'
#' @param obj an object of class \code{\link{pdmpModel}}
#' @param value the value that shall be set
#'
#' @include pdmp_class.R
#' @name pdmp-accessors
#' @seealso Class definition \code{\link{pdmpModel}}
NULL

#========= setGenerics ===========

#' @rdname pdmp-accessors
setGeneric("out", function(obj, value) standardGeneric("out"))
#' @rdname pdmp-accessors
setGeneric("out<-", function(obj, value) standardGeneric("out<-"))
#' @rdname pdmp-accessors
setGeneric("dynfunc", function(obj) standardGeneric("dynfunc"))
#' @rdname pdmp-accessors
setGeneric("dynfunc<-", function(obj, value) standardGeneric("dynfunc<-"))
#' @rdname pdmp-accessors
setGeneric("ratefunc", function(obj) standardGeneric("ratefunc"))
#' @rdname pdmp-accessors
setGeneric("ratefunc<-", function(obj, value) standardGeneric("ratefunc<-"))
#' @rdname pdmp-accessors
setGeneric("jumpfunc", function(obj) standardGeneric("jumpfunc"))
#' @rdname pdmp-accessors
setGeneric("jumpfunc<-", function(obj, value) standardGeneric("jumpfunc<-"))
#' @rdname pdmp-accessors
setGeneric("descr", function(obj) standardGeneric("descr"))
#' @rdname pdmp-accessors
setGeneric("descr<-", function(obj, value) standardGeneric("descr<-"))
#' @rdname pdmp-accessors
setGeneric("discStates", function(obj) standardGeneric("discStates"))
#' @rdname pdmp-accessors
setGeneric("discStates<-", function(obj, value) standardGeneric("discStates<-"))
#' @rdname pdmp-accessors
setGeneric("parms", function(obj, value) standardGeneric("parms")) 
#' @rdname pdmp-accessors
setGeneric("parms<-", function(obj, value) standardGeneric("parms<-"))
#' @rdname pdmp-accessors
setGeneric("init", function(obj, value) standardGeneric("init"))
#' @rdname pdmp-accessors
setGeneric("init<-", function(obj, value) standardGeneric("init<-"))
#' @rdname pdmp-accessors
setGeneric("solver", function(obj, value) standardGeneric("solver"))
#' @rdname pdmp-accessors
setGeneric("solver<-", function(obj, value) standardGeneric("solver<-"))
#' @rdname pdmp-accessors
setGeneric("times", function(obj, value) standardGeneric("times"))
#' @rdname pdmp-accessors
setGeneric("times<-", function(obj, value) standardGeneric("times<-"))
#' @rdname pdmp-accessors
setGeneric("initfunc", function(obj, value) standardGeneric("initfunc"))
#' @rdname pdmp-accessors
setGeneric("initfunc<-", function(obj, value) standardGeneric("initfunc<-"))

#======= Getters ==========

#' @rdname pdmp-accessors
#' @export
setMethod("out", "pdmpModel", function(obj) obj@out)
#' @rdname pdmp-accessors
#' @export
setMethod("dynfunc", "pdmpModel", function(obj) obj@dynfunc)
#' @rdname pdmp-accessors
#' @export
setMethod("ratefunc", "pdmpModel", function(obj) obj@ratefunc)
#' @rdname pdmp-accessors
#' @export
setMethod("jumpfunc", "pdmpModel", function(obj) obj@jumpfunc)
#' @rdname pdmp-accessors
#' @export
setMethod("descr", "pdmpModel", function(obj) obj@descr)
#' @rdname pdmp-accessors
#' @export
setMethod("discStates", "pdmpModel", function(obj) obj@discStates)
#' @rdname pdmp-accessors
#' @export
setMethod("parms", "pdmpModel", function(obj) obj@parms)
#' @rdname pdmp-accessors
#' @export
setMethod("init", "pdmpModel", function(obj) obj@init)
#' @rdname pdmp-accessors
#' @export
setMethod("solver", "pdmpModel", function(obj) obj@solver)
#' @rdname pdmp-accessors
#' @export
setMethod("times", "pdmpModel", function(obj) obj@times)
#' @rdname pdmp-accessors
#' @export
setMethod("initfunc", "pdmpModel", function(obj) obj@initfunc)

#======= Setters that set obj@out <- NULL =========

#' @rdname pdmp-accessors
#' @export
setMethod("out<-", "pdmpModel", function(obj, value) {
  obj@out <- value
  invisible(obj)
})
#' @rdname pdmp-accessors
#' @export
setMethod("dynfunc<-", "pdmpModel", function(obj, value) {
  obj@dynfunc <- value
  out(obj) <- NULL
  invisible(obj)
})
#' @rdname pdmp-accessors
#' @export
setMethod("ratefunc<-", "pdmpModel", function(obj, value) {
  obj@ratefunc <- value
  out(obj) <- NULL
  invisible(obj)
})
#' @rdname pdmp-accessors
#' @export
setMethod("jumpfunc<-", "pdmpModel", function(obj, value) {
  obj@jumpfunc <- value
  out(obj) <- NULL
  invisible(obj)
})
#' @rdname pdmp-accessors
#' @export
setMethod("discStates<-", "pdmpModel", function(obj, value) {
  obj@discStates <- value
  out(obj) <- NULL
  invisible(obj)
})
#' @rdname pdmp-accessors
#' @export
setMethod("parms<-", "pdmpModel", function(obj, value) {
  obj@parms <- value
  out(obj) <- NULL
  invisible(obj)
})
#' @rdname pdmp-accessors
#' @export
setMethod("init<-", "pdmpModel", function(obj, value) {
  obj@init <- value
  out(obj) <- NULL
  invisible(obj)
})
#' @rdname pdmp-accessors
#' @export
setMethod("solver<-", "pdmpModel", function(obj, value) {
  obj@solver <- value
  out(obj) <- NULL
  invisible(obj)
})
#' @rdname pdmp-accessors
#' @export
setMethod("times<-", "pdmpModel", function(obj, value) {
  obj@times <- value
  out(obj) <- NULL
  invisible(obj)
})
#' @rdname pdmp-accessors
#' @export
setMethod("initfunc<-", "pdmpModel", function(obj, value) {
   obj@initfunc <- value
   out(obj) <- NULL
   invisible(obj)
})

#======= Setters that don't change slot out =======

#' @rdname pdmp-accessors
#' @export
setMethod("descr<-", "pdmpModel", function(obj, value) {
  obj@descr <- value
  invisible(obj)
})