R/AllGenerics.R

In portfolioSim: Framework for simulating equity portfolio strategies

################################################################################
##
## $Id: AllGenerics.R 344 2006-10-01 05:06:05Z enos $
##
## Generics for the portfolioSim package.
##
################################################################################

## Should I check for existing generics like we do in 'portfolio'?

setGeneric("getSimData",
           function(object, period, verbose, ...) standardGeneric("getSimData"),
           valueClass = "simData")

setGeneric("getSimTrades",
           function(object, period, holdings, sim.data, verbose, ...) standardGeneric("getSimTrades"),
           valueClass = "simTrades")



setGeneric("runSim",
           function(object, verbose, ...) standardGeneric("runSim"),
           valueClass = "simResult")

setGeneric("saveOut",
           function(object, type, fmt, out.loc, name, verbose, ...) standardGeneric("saveOut"))

setGeneric("loadIn",
           function(object, in.loc, fmt, ...) standardGeneric("loadIn"))

## Utility

setGeneric("perfSummaryDf",
           function(object, ...) standardGeneric("perfSummaryDf"))

setGeneric("securityPerfSummaryDf",
           function(object, ...) standardGeneric("securityPerfSummaryDf"))

setGeneric("contributionSummaryDf",
           function(object, ...) standardGeneric("contributionSummaryDf"))