Class defining methods for all consumers

Description

A virtual base class representing components that can consume data from a Producer, and yield data to the user or other Consumer instances. A Consumer typically transforms records from one form to another. Producer and Consumer instances are associated with each other through the Stream function.

Methods

Methods defined on this class include:

Stream

Construct a stream from one Producer and one or more Consumer. See ?Stream.

Internal Class Fields and Methods

Internal fields of this class are are described with, e.g., getRefClass("Consumer")$fields.

Internal methods of this class are described with getRefClass("Consumer")$methods() and getRefClass("Consumer")$help().

Author(s)

Martin Morgan mtmorgan@fhcrc.org

See Also

Streamer-package, Streamer-class, Producer-class, Stream-class.

Examples

showClass("Consumer")

Results

R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(Streamer)
> png(filename="/home/ddbj/snapshot/RGM3/R_BC/result/Streamer/Consumer-class.Rd_%03d_medium.png", width=480, height=480)
> ### Name: Consumer
> ### Title: Class defining methods for all consumers
> ### Aliases: Consumer Consumer-class show,Consumer-method
> 
> ### ** Examples
> showClass("Consumer")
Class "Consumer" [package "Streamer"]

Slots:
                  
Name:       .xData
Class: environment

Extends: 
Class "Streamer", directly
Class "envRefClass", by class "Streamer", distance 2
Class ".environment", by class "Streamer", distance 3
Class "refClass", by class "Streamer", distance 3
Class "environment", by class "Streamer", distance 4, with explicit coerce
Class "refObject", by class "Streamer", distance 4

Known Subclasses: 
Class "Stream", directly
Class "Downsample", directly
Class "FunctionConsumer", directly
Class "Team", directly
Class "Reducer", directly
Class "DAGTeam", directly
Class "Utility", directly
Class "MulticoreTeam", by class "Team", distance 2
Class "RawToChar", by class "Utility", distance 2
Class "Rev", by class "Utility", distance 2
> 
> 
> 
> 
> dev.off()
null device 
          1 
>