DynamicPipeline {bdpar}R Documentation

Class implementing a dynamic pipelining process

Description

This DynamicPipeline class inherits from the GenericPipeline class. Includes the execute method which provides a dynamic pipelining implementation. '

Inherit

This class inherits from GenericPipeline and implements the execute abstract function.

Super class

bdpar::GenericPipeline -> DynamicPipeline

Methods

Public methods

Inherited methods

Method new()

Creates a DynamicPipeline object.

Usage
DynamicPipeline$new(pipeline = NULL)
Arguments
pipeline

A list of GenericPipe objects. Initializes the flow of GenericPipe.


Method add()

Adds a GenericPipe or a GenericPipe list to the pipeline.

Usage
DynamicPipeline$add(pipe, pos = NULL)
Arguments
pipe

A GenericPipe object or a list of GenericPipe objects.

pos

A (numeric) value. The value of the position to add. If it is NULL, GenericPipe is appended to the pipeline.


Method removeByPos()

Removes GenericPipes by the position on the pipeline.

Usage
DynamicPipeline$removeByPos(pos)
Arguments
pos

A (numeric) value. The value of the position to remove.


Method removeByPipe()

Removes GenericPipes by its name on the pipeline.

Usage
DynamicPipeline$removeByPipe(pipe.name)
Arguments
pipe.name

A (character) value. The GenericPipes name to remove.


Method removeAll()

Removes all GenericPipes included on pipeline.

Usage
DynamicPipeline$removeAll()

Method execute()

Function where is implemented the flow of the GenericPipes.

Usage
DynamicPipeline$execute(instance)
Arguments
instance

A (Instance) value. The Instance that is going to be processed.


Method get()

Gets a list with containing the set of GenericPipes of the pipeline.

Usage
DynamicPipeline$get()
Returns

The set of GenericPipes containing the pipeline.


Method print()

Prints pipeline representation. (Override print function)

Usage
DynamicPipeline$print(...)
Arguments
...

Further arguments passed to or from other methods.


Method toString()

Returns a character representing the pipeline

Usage
DynamicPipeline$toString()
Returns

DynamicPipeline character representation


Method clone()

The objects of this class are cloneable with this method.

Usage
DynamicPipeline$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

See Also

bdpar.log, Instance, DefaultPipeline, GenericPipeline, GenericPipe, %>|%


[Package bdpar version 3.0.0 Index]