DirectedConnection: Directed Connection Connection

In UptakeOpenSource/updraft: An R Based Workflow Manager

Description

Implementation of ConnectionInterface which represents a directed flow of info between a head module to a tail module.

Usage

DirectedConnection

Format

An object of class R6ClassGenerator of length 25.

Class Constructor

new(name, headModule, tailModule, inputArgument)

• name: unique character string that identifies this connection.

• headModule: obj that implements ModuleInterface or a character string that represents the head module of this connection.

• tailModule: obj that implements ModuleInterface or a character string that represents thetail module of this connection.

• inputArgument: Name of the inputArgument the output of the head module is used for in the tail module's execution.

Public

errorCheck(executionCheck = FALSE, ...)

• Runs error checking on the internal state of this object for erroneous values.

• executionCheck: when set to TRUE, runs additional checks to determine if ready for execution.

• ...: not used by this component.

• Returns: NULL, will raise a fatal error if an error is found.

filterOutputValue(outputValue)

• Filters the output of the headModule, outputValue, to what is expected by the tailModule. With this implementation of a connection, just returns outputValue.

• outputValue: output of headModule.

• Returns: outputValue

getHeadModuleName()

• Gets the name of the head module associated with this connection.

• Returns: a character string

getName()

• Gets the character string that identifies this connection.

• Returns: a character string

getInputArgument()

• Gets the argument the output of the head module is used for in the tail module's execution.

• Returns: a character vector

getSaveInfo()

• Gets a named list of internal states of this object which can be used to save this object on disk.

• Returns: a named list

getTailModuleName()

• Gets the name of the tail module associated with this connection.

• Returns: a character string

Private

inputArgument

• Name of the argument the output of the head module is used for in the tail module's execution.

headModuleName

• Stores name of the head module.

tailModuleName

• Stores name of the tail module.

extractNameFromModule(module)

• Extracts name of module.

• module: obj that implements ModuleInterface or a character string name of a module.

• Returns: Character string of module. Will raise a fatal error if module is not a character vector or a valid implementation of ModuleInterface.

Static Class Methods

DirectedConnection-cash-initFromSaveData

UptakeOpenSource/updraft documentation built on Oct. 17, 2019, 3:31 p.m.