Module Interface

Defines a contract of implementation for any module based class, i.e. a class that extends this interface. This class cannot be instantiated directly as it is abstract.

ModuleInterface

Format

An object of class R6ClassGenerator of length 24.

Contracted Methods

clearOutputCache()

Clears out the cached output of the associated module.

getFuncObj()

Gets the base R function object that is called when the associated module's execution is started.

getInput()

Gets a named logical vector where the names are the possible inputs into a module and the values indicate if an input is required.

getOutput()

Gets the output of the associated module.

hasCompleted()

Indicates if the associated module's execution has completed.

startExecution(argsList)

Starts the execution of the associated module with argsList as arguments.

See also

is.Module