File: getInstanceOf.Arguments.Rd

package info (click to toggle)
r-cran-r.utils 2.13.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,864 kB
  • sloc: sh: 18; makefile: 6
file content (54 lines) | stat: -rw-r--r-- 1,607 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
42
43
44
45
46
47
48
49
50
51
52
53
54
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  Arguments.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{Arguments$getInstanceOf}
\alias{Arguments$getInstanceOf}
\alias{getInstanceOf.Arguments}
\alias{Arguments.getInstanceOf}
\alias{getInstanceOf,Arguments-method}

\title{Gets an instance of the object that is of a particular class}

\description{
 Gets an instance of the object that is of a particular class.
}

\usage{
## Static method (use this):
## Arguments$getInstanceOf(object, class, coerce=FALSE, ..., .name=NULL)

## Don't use the below:
\method{getInstanceOf}{Arguments}(static, object, class, coerce=FALSE, ..., .name=NULL)
}

\arguments{
  \item{object}{The object that should be returned as an instance of
     class \code{class}.}
  \item{class}{A \code{\link[base]{character}} string specifying the name of the class that
     the returned object should inherit from.}
  \item{coerce}{If \code{\link[base:logical]{TRUE}} and the object is not of the wanted class, then
     method will be coerced to that class, if possible.  Otherwise,
     an error is thrown.}
  \item{...}{Not used.}
  \item{.name}{A \code{\link[base]{character}} string for name used in error messages.}
}

\value{
  Returns an object inheriting from class \code{class}.
}

\author{Henrik Bengtsson}

\seealso{
  For more information see \code{\link{Arguments}}.
}


\keyword{internal}
\keyword{methods}
\keyword{programming}