sc98-ProgressMonitor-class: Class "ProgressMonitor"

Description Usage Arguments Value Objects from the Class Methods Author(s)

Description

The ProgressMonitor class is a virtual class for abstract reporting of progress of a task. All the generic methods here are placeholders that must be extended to be used.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
is.ProgressMonitor(x)
## S4 method for signature 'ProgressMonitor'
progressDone(object, ...)
## S4 replacement method for signature 'ProgressMonitor,ANY'
progressDone(object, ...) <- value
## S4 method for signature 'ProgressMonitor'
progressError(object, ...)
## S4 replacement method for signature 'ProgressMonitor,ANY'
progressError(object, ...) <- value
## S4 method for signature 'ProgressMonitor'
progressLabel(object, ...)
## S4 replacement method for signature 'ProgressMonitor,ANY'
progressLabel(object, ...) <- value
## S4 method for signature 'ProgressMonitor'
progressMaximum(object, ...)
## S4 replacement method for signature 'ProgressMonitor,ANY'
progressMaximum(object, ...) <- value
## S4 method for signature 'ProgressMonitor'
progressMinimum(object, ...)
## S4 replacement method for signature 'ProgressMonitor,ANY'
progressMinimum(object, ...) <- value
## S4 method for signature 'ProgressMonitor'
progressValue(object, ...)
## S4 replacement method for signature 'ProgressMonitor,ANY'
progressValue(object, ...) <- value

Arguments

x

object of (sub)class ProgressMonitor

object

object of (sub)class ProgressMonitor

...

extra arguments for generic routines

value

value to be assigned

Value

The is.ProgressMonitor method returns TRUE if its argument is an object of class ProgressMonitor.

Objects from the Class

This class should not be instantiated directly; extend this class instead.

Methods

progressDone

signature(object = "ProgressMonitor"):
Placeholder method which must be implemented by subclass.

progressError

signature(object = "ProgressMonitor"):
Placeholder method which must be implemented by subclass.

progressLabel

signature(object = "ProgressMonitor"):
Placeholder method which must be implemented by subclass.

progressMaximum

signature(object = "ProgressMonitor"):
Placeholder method which must be implemented by subclass.

progressMinimum

signature(object = "ProgressMonitor"):
Placeholder method which must be implemented by subclass.

progressValue

signature(object = "ProgressMonitor"):
Placeholder method which must be implemented by subclass.

Author(s)

P. Roebuck proebuck@mdanderson.org


SuperCurve documentation built on May 2, 2019, 6:14 p.m.