rstream (version 1.2.2)

rstream.packed-methods: Methods for Function rstream.packed in Package `rstream'

Description

Get status (packed/unopacked) of an "rstream" object in package rstream. Pack and unpack an "rstream" object in package rstream.

When a "rstream" object should be used in another Rsession or saved for some kind of later reuse all information about the object must be packed. Notice no method other than unpacking can be applied to a packed object. It must be unpacked before.

Usage

## S3 method for class 'rstream':
rstream.packed(stream)
rstream.packed(stream) <- value

Arguments

stream

an "rstream" object.

value

a boolean (TRUE or FALSE) to change the status of the object. TRUE: pack the object. FALSE: unpack the object.

Methods

Methods available for all "rstream" subclasses: rstream.mrg32k3a-class, rstream.runif-class.

See Also

rstream-class.

Examples

## create a new rstream object (of subclass rstream.mrg32k3a)
s <- new("rstream.mrg32k3a")

## pack rstream object
rstream.packed(s) <- TRUE

## status of object 
rstream.packed(s)

## pack rstream object
rstream.packed(s) <- FALSE