Rcpp::Reference Class Reference

#include <Reference.h>

Inheritance diagram for Rcpp::Reference:

Collaboration diagram for Rcpp::Reference:

List of all members.

Classes
class	FieldProxy
Public Member Functions
	Reference ()
	Reference (SEXP x)
	Reference (const Reference &other)
	Reference (const RObject::SlotProxy &proxy)
	Reference (const RObject::AttributeProxy &proxy)
Reference &	operator= (const Reference &other)
Reference &	operator= (SEXP other)
	Reference (const std::string &klass)
FieldProxy	field (const std::string &name) const
Private Member Functions
void	set (SEXP x)
Friends
class	FieldProxy

---

Detailed Description

S4 object (of a reference class)

Definition at line 33 of file Reference.h.

---

Constructor & Destructor Documentation

Rcpp::Reference::Reference

(

)

Definition at line 28 of file Reference.cpp.

Rcpp::Reference::Reference

(

SEXP

x

)

checks that x is an S4 object of a reference class and wrap it.

Parameters:

x	must be an S4 object of some reference class

Definition at line 30 of file Reference.cpp.

References x.

Rcpp::Reference::Reference

(

const Reference &

other

)

copy constructor

Parameters:

other

other S4 object

Definition at line 34 of file Reference.cpp.

References Rcpp::RObject::asSexp(), and Rcpp::RObject::setSEXP().

Here is the call graph for this function:

Rcpp::Reference::Reference

(

const RObject::SlotProxy &

proxy

)

Definition at line 38 of file Reference.cpp.

Rcpp::Reference::Reference

(

const RObject::AttributeProxy &

proxy

)

Definition at line 41 of file Reference.cpp.

Rcpp::Reference::Reference

(

const std::string &

klass

)

Creates an reference object of the requested class.

Parameters:

klass

name of the target reference class

Exceptions:

reference_creation_error

if klass does not map to a known S4 class

Definition at line 55 of file Reference.cpp.

References PROTECT(), Rcpp::RObject::setSEXP(), and Rcpp::internal::try_catch().

Here is the call graph for this function:

---

Member Function Documentation

Reference::FieldProxy Rcpp::Reference::field

(

const std::string &

name

)

const

Definition at line 106 of file Reference.cpp.

References FieldProxy.

Referenced by Rcpp::S4_CppConstructor< Class >::S4_CppConstructor(), Rcpp::S4_CppOverloadedMethods< Class >::S4_CppOverloadedMethods(), and Rcpp::S4_field< Class >::S4_field().

Reference & Rcpp::Reference::operator=

(

SEXP

other

)

Assignement operator. Set this SEXP to the given SEXP

Reimplemented from Rcpp::S4.

Definition at line 50 of file Reference.cpp.

Reference & Rcpp::Reference::operator=

(

const Reference &

other

)

Definition at line 45 of file Reference.cpp.

References Rcpp::RObject::asSexp(), and Rcpp::RObject::setSEXP().

Here is the call graph for this function:

void Rcpp::Reference::set

(

SEXP

x

)

[private]

Reimplemented from Rcpp::S4.

Definition at line 63 of file Reference.cpp.

References Rcpp::RObject::setSEXP().

Here is the call graph for this function:

---

Friends And Related Function Documentation

friend class FieldProxy [friend]

Definition at line 113 of file Reference.h.

Referenced by field().

---

The documentation for this class was generated from the following files:

• inst/include/Rcpp/Reference.h
• src/Reference.cpp