sc98-ProgressMonitor-methods: Methods for Manipulating Progress Monitors

In SuperCurve: RPPA Analysis Package

Description

These are generic functions used as accessors and mutators for objects of Progress-related classes.

progressDone:

determines whether the task has been completed.

progressError:

determines whether an error occurred attempting to complete the task.

progressLabel:

determines label "applied" to the task.

progressMinimum:

determines value associated with initiating the task.

progressMaximum:

determines value associated with completing the task.

progressValue:

determines value associated with percentage of the task completed.

The method invokes particular methods which depend on the class of the first argument.

Usage

## S4 method for signature 'ANY'
progressDone(object)
## S4 replacement method for signature 'ANY,ANY'
progressDone(object, ...) <- value
## S4 method for signature 'ANY'
progressError(object)
## S4 replacement method for signature 'ANY,ANY'
progressError(object, ...) <- value
## S4 method for signature 'ANY'
progressLabel(object)
## S4 replacement method for signature 'ANY,ANY'
progressLabel(object, ...) <- value
## S4 method for signature 'ANY'
progressMaximum(object)
## S4 replacement method for signature 'ANY,ANY'
progressMaximum(object, ...) <- value
## S4 method for signature 'ANY'
progressMinimum(object)
## S4 replacement method for signature 'ANY,ANY'
progressMinimum(object, ...) <- value
## S4 method for signature 'ANY'
progressValue(object)
## S4 replacement method for signature 'ANY,ANY'
progressValue(object, ...) <- value

Arguments

object	object of (sub)class ProgressMonitor
value	new value to apply
...	additional arguments affecting the updated values

Details

All functions are generic: you must write methods to handle specific classes of objects.

Value

The form of the value returned by these methods depends on the class of its argument. See the documentation of the particular methods for details of what is produced by that method.

Author(s)

P. Roebuck [e-mail]

See Also

ProgressMonitor, DefaultProgressMonitor

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