R/ConstantInternalFluxRate_by_PoolIndex.R

In SoilR: Models of Soil Organic Matter Decomposition

# constructor from number like objects



#' automatic title
#' 
#' @param sourceIndex no manual documentation
#' @param destinationIndex no manual documentation
#' @param rate_constant no manual documentation
#' @autocomment These comments were created by the auto_comment_roclet by
#' inspection of the code.  You can use the "update_auto_comment_roclet" to
#' automatically adapt them to changes in the source code. This will remove
#' `@param` tags for parameters that are no longer present in the source code
#' and add `@param` tags with a default description for yet undocumented
#' parameters.  If you remove this `@autocomment` tag your comments will no
#' longer be touched by the "update_autocomment_roclet".
setMethod(
    f='ConstantInternalFluxRate_by_PoolIndex'
    ,signature=signature(
        sourceIndex='numeric'
        ,destinationIndex='numeric'
        ,src_to_dest='missing'
        ,rate_constant='numeric'
    )
    ,definition=function(
        sourceIndex
        ,destinationIndex
        ,rate_constant
    ){
        new(
            'ConstantInternalFluxRate_by_PoolIndex'
            ,sourceIndex=PoolIndex(sourceIndex)
            ,destinationIndex=PoolIndex(destinationIndex)
            ,rate_constant=rate_constant
        )
    }
)

# #' constructor from strings of the form '1_to_2'
# setMethod(
#   f="ConstantInternalFluxRate_by_PoolIndex",
#   signature=signature(
#     sourceIndex='missing'
#     ,destinationIndex='missing'
#     ,src_to_dest='character'
#     ,rate_constant='numeric'
#   ),
#   def=function(src_to_dest,rate_constant){
#       new(
#           "ConstantInternalFluxRate_by_PoolIndex"
#           ,sourceIndex=getSenderIndex(src_to_dest)
#           ,destinationIndex=getRecipientIndex(src_to_dest)
#           ,rate_constant=rate_constant
#       )
#   }
# )
# 
# #' new object with the source pool id converted to a PoolIndex if necessary 
# setMethod(
#   f="by_PoolName",
#   signature=c(obj='ConstantInternalFluxRate_by_PoolIndex'),
#   def=function(obj,poolNames){
#       new(
#         'ConstantInternalFluxRate_by_PoolName'
#         ,sourceName      =   PoolName(obj@sourceIndex,poolNames)
#         ,destinationName =   PoolName(obj@destinationIndex,poolNames)
#         ,rate_constant   =   obj@rate_constant
#       )
#   }
# )