Get the definition of a class.
getClass(Class, .Force = FALSE, where) getClassDef(Class, where, package, inherits = TRUE)
- the character-string name of the class, often with a
"package"attribute as noted below under
NULLif the class is undefined; otherwise, an undefined class results in an error.
- environment from which to begin the search for the definition; by default, start at the top-level (global) environment and proceed through the search list.
- the name of the package asserted to hold the definition. If it is a non-empty string it is used instead of
where, as the first place to look for the class. Note that the package must be loaded but need not be attached. By default, the package attribute of the
Classargument is used, if any. There will usually be a package attribute if
class(x)for some object.
- Should the class definition be retrieved from any enclosing environment and also from the cache? If
FALSEonly a definition in the environment
wherewill be returned.
Class definitions are stored in metadata objects in a package namespace or other environment where they are defined. When packages are loaded, the class definitions in the package are cached in an internal table. Therefore, most calls to
getClassDef will find the class in the cache or fail to find it at all, unless
FALSE, in which case only the environment(s) defined by
where are searched.
The class cache allows for multiple definitions of the same class name in separate environments, with of course the limitation that the package attribute or package name must be provided in the call to
The object defining the class. If the class definition is not found,
getClass, which calls
getClassDef, either generates an error or, if
TRUE, returns a simple definition for the class. The latter case is used internally, but is not typically sensible in user code.
The non-null returned value is an object of class
classRepresentation. For all reasonable purposes, use this object only to extract information, rather than trying to modify it: Use functions such as
setIs to create or modify class definitions.
Chambers, John M. (2008) Software for Data Analysis: Programming with R Springer. (For the R version.)
Chambers, John M. (1998) Programming with Data Springer (For the original S4 version.)
Documentation reproduced from R 3.0.2. License: GPL-2.