sc98-BoundedRange-class: Class "BoundedRange"

In SuperCurve: RPPA Analysis Package

Description

The BoundedRange class represents an attempt to abstract reporting of progress of a task. This class assumes that progress is reported via a progressbar and provides means to get/set values for such a widget.

Usage

BoundedRange(value, minimum=1, maximum=100)
is.BoundedRange(x)
## S4 method for signature 'BoundedRange'
progressMaximum(object)
## S4 replacement method for signature 'BoundedRange,numeric'
progressMaximum(object) <- value
## S4 method for signature 'BoundedRange'
progressMinimum(object)
## S4 replacement method for signature 'BoundedRange,numeric'
progressMinimum(object) <- value
## S4 method for signature 'BoundedRange'
progressValue(object)
## S4 replacement method for signature 'BoundedRange,numeric'
progressValue(object) <- value

Arguments

minimum	integer specifying desired minimum value of closed interval
maximum	integer specifying desired maximum value of closed interval
value	integer specifying desired current value
object	object of class BoundedRange
x	object of class BoundedRange

Value

The BoundedRange generator returns an object of class BoundedRange.

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

Objects from the Class

Although objects of the class can be created by a direct call to new, the preferred method is to use the BoundedRange generator function.

Slots

minimum:

integer specifying the minimum value of the closed interval. Default is 1.

maximum:

integer specifying the minimum value of the closed interval. Default is 100.

value:

integer specifying current value. Must be in the closed interval minimum..maximum

Methods

progressMaximum

signature(object = "BoundedRange"):
Returns integer representing maximum value of interval.

progressMaximum<-

signature(object = "BoundedRange", value = "numeric"):
Sets the value of the maximum slot.

progressMinimum

signature(object = "BoundedRange"):
Returns integer representing minimum value of interval.

progressMinimum<-

signature(object = "BoundedRange", value = "numeric"):
Sets the value of the minimum slot.

progressValue

signature(object = "BoundedRange"):
Returns integer representing current value.

progressValue<-

signature(object = "BoundedRange", value = "numeric"):
Sets the value of the value slot.

Author(s)

P. Roebuck [e-mail]

Examples

showClass("BoundedRange")
br <- BoundedRange(3, maximum=10)
progressValue(br) <- 5 # Modify current value

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