comp {objectProperties} | R Documentation |
Bounded types for properties
Description
This set of classes define different numerical object with restriction on it.
Usage
PositiveInteger(object)
Arguments
object |
object to be coerced |
Details
These special classes could be registered as signaling fields by calling
signalingFields
or signalingField
, or using setProperties
,
so they could be used for GUI design, and changing of the fields automatically
validate the current value
The construction of these objects has validation with them, please see the example.
- PositiveInteger(object)
Construct a
PositiveInteger
object- NonpositiveInteger(object)
Construct a
NonpositiveInteger
object- NegativeInteger(object)
Construct a
NegativeInteger
object- NonnegativeInteger(object)
Construct a
NonnegativeInteger
object
Value
An object of the corresponding class
Author(s)
Tengfei Yin, Michael Lawrence
Examples
## Constructors
require(objectProperties)
obj <- PositiveInteger(1)
obj <- NonnegativeInteger(0)
obj <- NegativeInteger(-1)
obj <- NonpositiveInteger(0)
## setting as properties
filt.gen <- setRefClass("Filter",
properties(list(cutoff = "NonnegativeInteger",
weight = "PositiveInteger")), contains = "PropertySet")
## new property instance
obj <- filt.gen$new(cutoff = 0, weight = 1)
obj$properties()
as.list(obj)
## get the value
obj$cutoff
## set the value
obj$cutoff <- 30
## the class doesn't change
## if you pass a value which out of boundary, it will throw an error message
obj$cutoff
class(obj$cutoff)
[Package objectProperties version 0.6.8 Index]