R/Action_update_vm.R

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

#----------------------------------------------------------------------------------------------------------------------------------------------------
#           update_vm_action
#----------------------------------------------------------------------------------------------------------------------------------------------------
##' Mise a jour de valeurs de marche d'un portefeuille action.
##'
##' \code{update_vm_action} est une methode permettant de mettre a jour la valeur de marche des composantes d'un portefeuille Action.
##' @name update_vm_action
##' @docType methods
##' @param x objet de la classe \code{\link{Action}} (decrivant le portefeuille action en detention).
##' @param vm un vecteur de \code{numeric} ayant la meme longueur que le portefeuille action a de lignes
##' et correspondant aux nouvelles valeurs de marche du portefeuille action.
##' @return L'objet \code{x} mis a jour.
##' @author Prim'Act
##' @export
##' @include Action_class.R


setGeneric(name = "update_vm_action", def = function(x, vm) {
    standardGeneric("update_vm_action")
})
setMethod(
    f = "update_vm_action",
    signature = c(x = "Action", vm = "numeric"),
    definition = function(x, vm) {
        # Donnees
        ptf_action <- x@ptf_action

        # Verification des inputs
        if (nrow(ptf_action) != length(vm)) stop("[Action : update_vm_action] : Les inputs ne sont pas de memes dimensions")
        if (sum(vm < 0) > 0) stop("[Action : update_vm_action] : Le vecteur de VM initialement entre ne peut contenir de valeurs negatives. \n")

        # Modification de la VM
        x@ptf_action$val_marche <- vm

        # Output
        return(x)
    }
)