R/category.R

In ceg: Chain Event Graph

#' Category S4 Class
#'
#' Category S4 class contains a single slot with the category label. It is used
#' to construct Stratified.event.tree objects.
#'
#' @slot label character
#'
#' @export
#'
setClass(
  "Category",
  representation(
    label = "character"),
  validity = function(object) {
       if (object@label == "") stop("Category@label cannot be void")
       if (grepl("^\\s*$", object@label)) stop("Category@label cannot be only blanc spaces")
    TRUE
  }
)



setMethod(
  f = "initialize",
  signature = "Category",
  definition = function(.Object,
                        label){
    cat("~~~ Category: initializator ~~~ \n")
    # Assignment of the slots
    .Object@label <- label
    methods::validObject(.Object)
    return(.Object)
    # return of the object
  }
)

#' Category(label)
#'
#' Category(label) is a function that act as constructor to Category S4 object.
#' Category S4 class contains a single slot with the category labels. It is used
#' to construct S4 Variable objects, which, in turn, aim at being parameters in
#' Stratified.event.tree objects manual constructions.
#'
#' @param label caracter, the category name
#'
#' @return a \code{\link{Category}} S4 object
#'
#' @export
#'
#' @examples
#' cat <- Category("category.name")
#'
#' @examples
#' Category("category.name2")
#'
#'
Category <- function(label){
          new("Category", label)
    }