R/AutresReserves-class.R

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

#----------------------------------------------------------
# Ce script est la definition de la classe AutresPassifs dediee aux model points des autres reserves
# Il s'agit d'une classe ajoutee specifiquement pour gerer des passifs hors modeles.
#----------------------------------------------------------

#----------------------------------------------------------------------------------------------------------------------------------------------------
#           Definition de la classe AutresReserves
#----------------------------------------------------------------------------------------------------------------------------------------------------

##' La classe AutreReserves
##'
##' Une classe de parametres permettant de gerer le stock de provision globale de gestion (PGG) et de
##' provision pour sinistres a payer (PSAP).
##'
##' @name AutresReserves
##' @slot pgg_debut la valeur de la PGG en debut de periode.
##' @slot psap_debut la valeur de la PSAP en debut de periode.
##' @slot pgg_valeur la valeur courant de la PGG.
##' @slot psap_valeur la valeur courant de la PSAP.
##' @slot tx_pgg_ep le taux de PGG applique sur l'epargne.
##' @slot tx_pgg_autres le taux de PGG applique sur les autres passifs.
##' @slot tx_psap_ep le taux de PGG applique sur l'epargne.
##' @slot tx_psap_autres le taux de PGG applique sur les autres passifs.
##' @docType class
##' @author Prim'Act
##' @seealso Le calcul et la mise a jour des autres reserves \code{\link{update_reserves}} et
##' \code{\link{init_debut_pgg_psap}}.
##' @keywords classes
##' @export
setClass(
  Class = "AutresReserves",
  representation = representation(
    pgg_debut = "numeric",
    psap_debut = "numeric",
    pgg_valeur = "numeric",
    psap_valeur = "numeric",
    tx_pgg_ep = "numeric",
    tx_pgg_autres = "numeric",
    tx_psap_ep = "numeric",
    tx_psap_autres = "numeric"
  )
)

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

    # Test sur les types
    if (!is.numeric(object@pgg_debut)) retval <- c(retval, "[AutresReserves] : pgg_debut n'est pas numeric/n")
    if (!is.numeric(object@psap_debut)) retval <- c(retval, "[AutresReserves] : psap_debut n'est pas numeric/n")
    if (!is.numeric(object@pgg_valeur)) retval <- c(retval, "[AutresReserves] : pgg_valeur n'est pas numeric/n")
    if (!is.numeric(object@psap_valeur)) retval <- c(retval, "[AutresReserves] : psap_valeur n'est pas numeric/n")
    if (!is.numeric(object@tx_pgg_ep)) retval <- c(retval, "[AutresReserves] : tx_pgg_ep n'est pas numeric/n")
    if (!is.numeric(object@tx_pgg_autres)) retval <- c(retval, "[AutresReserves] : tx_pgg_autres n'est pas numeric/n")
    if (!is.numeric(object@tx_psap_ep)) retval <- c(retval, "[AutresReserves] : tx_psap_ep n'est pas numeric/n")
    if (!is.numeric(object@tx_psap_autres)) retval <- c(retval, "[AutresReserves] : tx_psap_autres n'est pas numeric/n")


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