File: CppObject-class.Rd

package info (click to toggle)
rcpp 0.8.5-1
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 7,472 kB
  • ctags: 8,525
  • sloc: ansic: 17,959; cpp: 12,632; makefile: 134; sh: 15
file content (36 lines) | stat: -rw-r--r-- 1,102 bytes parent folder | download
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
\name{C++Object-class}
\Rdversion{1.1}
\docType{class}
\alias{C++Object-class}
\alias{$,C++Object-method}
\alias{$<-,C++Object-method}
\alias{show,C++Object-method}

\title{c++ internal objects}
\description{
C++ internal objects instanciated from a class exposed in an Rcpp module
}
\section{Objects from the Class}{
	Objects can be created by the \code{new} method of the
	\linkS4class{C++Class} class.
}
\section{Extends}{
	Class \code{"\linkS4class{C++ObjectS3}"}, directly.
	Class \code{"\linkS4class{oldClass}"}, by class "C++ObjectS3", distance 2.
}

\section{Slots}{
  \describe{
    \item{\code{module}:}{external pointer to the module}
    \item{\code{cppclass}:}{external pointer to the c++ class}
    \item{\code{pointer}:}{external pointer to the c++ object}
  }
}
\section{Methods}{
  \describe{
    \item{$}{\code{signature(x = "C++Object")}: invokes a method on the object, or retrieves the value of a property }
	\item{$<-}{\code{signature(x = "C++Object")}: set the value of a property }
	\item{show}{\code{signature(object = "C++Object")}: print the object }
	 }
}
\keyword{classes}