Description Usage Arguments Value Objects from the Class Slots Methods Author(s) Examples
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.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | 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
|
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 |
x |
object of class |
The BoundedRange
generator returns an object of class
BoundedRange
.
The is.BoundedRange
method returns TRUE
if its
argument is an object of class BoundedRange
.
Although objects of the class can be created by a direct call to
new, the preferred method is to use the
BoundedRange
generator function.
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
signature(object = "BoundedRange")
:
Returns integer representing maximum value of interval.
signature(object = "BoundedRange", value = "numeric")
:
Sets the value of the maximum
slot.
signature(object = "BoundedRange")
:
Returns integer representing minimum value of interval.
signature(object = "BoundedRange", value = "numeric")
:
Sets the value of the minimum
slot.
signature(object = "BoundedRange")
:
Returns integer representing current value.
signature(object = "BoundedRange", value = "numeric")
:
Sets the value of the value
slot.
P. Roebuck proebuck@mdanderson.org
1 2 3 | showClass("BoundedRange")
br <- BoundedRange(3, maximum=10)
progressValue(br) <- 5 # Modify current value
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.