R/Treso_class.R

In qguibert/SimBEL: Un package de calcul du best estimate epargne sous Solvabilite 2

#----------------------------------------------------------------------------------------------------------------------------------------------------
#           Declarateur
#----------------------------------------------------------------------------------------------------------------------------------------------------
##' La classe \code{Treso}.
##'
##' Une classe pour les actifs de type Tresorerie.
##'
##' @name Treso
##' @slot ptf_treso est un dataframe, chaque ligne represente un actif de tresorerie du portefeuille de monetaire.
##' @docType class
##' @author Prim'Act
##' @seealso Les methodes de calcul des valeurs \code{\link{calc_vm_treso}},
##' de calcul des revenus de la tresorerie \code{\link{revenu_treso}},
##' de calcul de la revalorisation de la tresorerie \code{\link{revalo_treso}},
##' de mise a jour de la tresorerie \code{\link{update_treso}}.
##' @keywords classes
##' @export
##' @aliases Treso

setClass(
    Class = "Treso",
    representation = representation(
        ptf_treso = "data.frame"
    )
)

#----------------------------------------------------------------------------------------------------------------------------------------------------
#           Verificateur et initialisateur
#----------------------------------------------------------------------------------------------------------------------------------------------------
# Verificateur : permet a chaque appel de l'objet de verifier quelques elements de base :
setValidity(
    Class = "Treso",
    function(object) {
        retval <- NULL
        nb_col <- 3L
        ptf_treso <- object@ptf_treso

        # Verification du nombre de colonnes
        if (dim(ptf_treso)[2L] != nb_col) {
            retval <- c(
                retval, "[Treso] : Nombre d'attributs incorrect, un ptf Treso est compose d'un DF de 3 colonnes \n"
            )
        }
        if (nrow(ptf_treso) > 1L) retval <- c(retval, "[Treso] : Un seul compte de tresorerie est tolere \n")

        # Verification du type des colonnes
        if (!is.integer(ptf_treso[, 1L])) retval <- c(retval, "[Treso] : num_mp n'est pas entier\n")
        if (!is.numeric(ptf_treso[, 2L])) retval <- c(retval, "[Treso] : val_marche n'est pas reel\n")
        if (!is.numeric(ptf_treso[, 3L])) retval <- c(retval, "[Treso] : val_nc n'est pas reel\n")

        # Verification du nom des colonnes
        if (sum(colnames(ptf_treso) == c("num_mp", "val_marche", "val_nc")) != nb_col) retval <- c(retval, "[Treso] : Noms de colonne incorrect\n")

        if (is.null(retval)) {
            return(TRUE)
        } else {
            return(retval)
        }
    }
)

# Initialisateur : permet de construire l'objet initial, selon 2 cas :
#           - Objet vide
#           - Objet renseign?.
#           - Erreur autrement
setMethod(
    f = "initialize",
    signature = "Treso",
    definition = function(.Object, ptf = data.frame()) {
        nb_col <- 3

        # Traitement du cas ou tout les elements sont renseignes
        if (!missing(ptf)) {
            if (ncol(ptf) != nb_col | sum(names(ptf) != c("num_mp", "val_marche", "val_nc")) != 0L) {
                stop("[Treso] : Nombre ou nommage des colonnes du dataframe incorrect")
            } else if (!is.integer(ptf[, "num_mp"]) | !is.numeric(ptf[, "val_marche"]) | !is.numeric(ptf[, "val_nc"])) {
                stop("[Treso] : Typage incorrect des colonnes du dataframe")
            } else {
                .Object@ptf_treso <- ptf
                validObject(.Object)
            }
        } else { # Traitement du cas vide
            .Object@ptf_treso <- data.frame(integer(), numeric(), numeric())
            colnames(.Object@ptf_treso) <- c("num_mp", "val_marche", "val_nc")
        }

        return(.Object)
    }
)