File: nwsFind-methods.Rd

package info (click to toggle)
r-cran-nws 2.0.0.3-5
  • links: PTS
  • area: main
  • in suites: buster
  • size: 1,056 kB
  • sloc: python: 1,464; makefile: 2
file content (41 lines) | stat: -rw-r--r-- 1,061 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
\name{nwsFind}
\docType{methods}
\alias{nwsFind}
\alias{nwsFind-methods}
\alias{nwsFind,netWorkSpace-method}
\title{Find a Stored Value}
\description{
Find a value associated with a variable in a shared netWorkSpace.
}

\usage{
\S4method{nwsFind}{netWorkSpace}(.Object, xName)
}

\arguments{
\item{.Object}{a netWorkSpace class object.}
\item{xName}{character string specifying the name of the variable to find.}
}

\details{
The \code{nwsFind} method looks in the shared netWorkSpace \code{.Object}
for a value bound to \code{xName}; if it finds such a value, \code{nwsFind}
returns it but does not remove it. If no value is found, \code{nwsFind}
blocks until a value for \code{xName} becomes available.
If there is more than one value associated with \code{xName}, the
particular value returned depends on \code{xName}'s behavior. See
\code{\link{nwsDeclare}} for details.
}

\seealso{ \code{\link{nwsDeclare}}, \code{\link{nwsFetch}}}

\examples{
\dontrun{
ws <- netWorkSpace('nws example')
nwsStore(ws, 'x', 1)
x <- nwsFind(ws, 'x')
}
}


\keyword{methods}