Rcpp Version 0.9.10
Public Types | Public Member Functions | Private Member Functions | Private Attributes
Rcpp::class_< Class > Class Template Reference

#include <Module.h>

Inheritance diagram for Rcpp::class_< Class >:
Inheritance graph
[legend]
Collaboration diagram for Rcpp::class_< Class >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef class_< Class > self
typedef CppMethod< Class > method_class
typedef SignedMethod< Class > signed_method_class
typedef std::vector
< signed_method_class * > 		vec_signed_method
typedef std::map< std::string,
vec_signed_method * > 		map_vec_signed_method
typedef std::pair< std::string,
vec_signed_method * > 		vec_signed_method_pair
typedef std::map< std::string,
method_class * > 		METHOD_MAP
typedef std::pair< const
std::string, method_class * > 		PAIR
typedef Rcpp::XPtr< Class > XP
typedef CppFinalizer< Class > finalizer_class
typedef Constructor_Base< Class > constructor_class
typedef SignedConstructor< Class > signed_constructor_class
typedef std::vector
< signed_constructor_class * > 		vec_signed_constructor
typedef CppProperty< Class > prop_class
typedef std::map< std::string,
prop_class * > 		PROPERTY_MAP
typedef std::pair< const
std::string, prop_class * > 		PROP_PAIR

Public Member Functions

 class_ (const char *name_, const char *doc=0)
 ~class_ ()
self & AddConstructor (constructor_class *ctor, ValidConstructor valid, const char *docstring=0)
self & default_constructor (const char *docstring=0, ValidConstructor valid=&yes_arity< 0 >)
std::string get_typeinfo_name ()
SEXP newInstance (SEXP *args, int nargs)
bool has_default_constructor ()
SEXP invoke (SEXP method_xp, SEXP object, SEXP *args, int nargs)
SEXP invoke_void (SEXP method_xp, SEXP object, SEXP *args, int nargs)
SEXP invoke_notvoid (SEXP method_xp, SEXP object, SEXP *args, int nargs)
self & AddMethod (const char *name_, method_class *m, ValidMethod valid=&yes, const char *docstring=0)
self & AddProperty (const char *name_, prop_class *p)
bool has_method (const std::string &m)
bool has_property (const std::string &m)
bool property_is_readonly (const std::string &p)
std::string property_class (const std::string &p)
Rcpp::CharacterVector method_names ()
Rcpp::IntegerVector methods_arity ()
Rcpp::LogicalVector methods_voidness ()
Rcpp::CharacterVector property_names ()
Rcpp::List property_classes ()
Rcpp::CharacterVector complete ()
SEXP getProperty (SEXP field_xp, SEXP object)
void setProperty (SEXP field_xp, SEXP object, SEXP value)
Rcpp::List fields (SEXP class_xp)
Rcpp::List getMethods (SEXP class_xp, std::string &buffer)
Rcpp::List getConstructors (SEXP class_xp, std::string &buffer)
self & finalizer (void(*f)(Class *))
virtual void run_finalizer (SEXP object)

Private Member Functions

void SetFinalizer (finalizer_class *f)
 class_ ()

Private Attributes

map_vec_signed_method vec_methods
PROPERTY_MAP properties
finalizer_class * finalizer_pointer
int specials
vec_signed_constructor constructors
self * class_pointer
std::string typeinfo_name

Detailed Description

template<typename Class>
class Rcpp::class_< Class >

Definition at line 335 of file Module.h.

Member Typedef Documentation

template<typename Class >
typedef Constructor_Base<Class> Rcpp::class_< Class >::constructor_class

Definition at line 351 of file Module.h.

template<typename Class >
typedef CppFinalizer<Class> Rcpp::class_< Class >::finalizer_class

Definition at line 349 of file Module.h.

template<typename Class >
typedef std::map<std::string,vec_signed_method*> Rcpp::class_< Class >::map_vec_signed_method

Definition at line 342 of file Module.h.

template<typename Class >
typedef CppMethod<Class> Rcpp::class_< Class >::method_class

Definition at line 338 of file Module.h.

template<typename Class >
typedef std::map<std::string,method_class*> Rcpp::class_< Class >::METHOD_MAP

Definition at line 345 of file Module.h.

template<typename Class >
typedef std::pair<const std::string,method_class*> Rcpp::class_< Class >::PAIR

Definition at line 346 of file Module.h.

template<typename Class >
typedef CppProperty<Class> Rcpp::class_< Class >::prop_class

Definition at line 355 of file Module.h.

template<typename Class >
typedef std::pair<const std::string,prop_class*> Rcpp::class_< Class >::PROP_PAIR

Definition at line 357 of file Module.h.

template<typename Class >
typedef std::map<std::string,prop_class*> Rcpp::class_< Class >::PROPERTY_MAP

Definition at line 356 of file Module.h.

template<typename Class >
typedef class_<Class> Rcpp::class_< Class >::self

Definition at line 337 of file Module.h.

template<typename Class >
typedef SignedConstructor<Class> Rcpp::class_< Class >::signed_constructor_class

Definition at line 352 of file Module.h.

template<typename Class >
typedef SignedMethod<Class> Rcpp::class_< Class >::signed_method_class

Definition at line 340 of file Module.h.

template<typename Class >
typedef std::vector<signed_constructor_class*> Rcpp::class_< Class >::vec_signed_constructor

Definition at line 353 of file Module.h.

template<typename Class >
typedef std::vector<signed_method_class*> Rcpp::class_< Class >::vec_signed_method

Definition at line 341 of file Module.h.

template<typename Class >
typedef std::pair<std::string,vec_signed_method*> Rcpp::class_< Class >::vec_signed_method_pair

Definition at line 343 of file Module.h.

template<typename Class >
typedef Rcpp::XPtr<Class> Rcpp::class_< Class >::XP

Definition at line 348 of file Module.h.

Constructor & Destructor Documentation

template<typename Class >
Rcpp::class_< Class >::class_ ( const char *  name_,
const char *  doc = 0 
) [inline]

Definition at line 359 of file Module.h.

References Rcpp::Module::AddClass(), Rcpp::class_< Class >::class_pointer, Rcpp::class_Base::docstring, Rcpp::class_< Class >::finalizer_pointer, getCurrentScope(), Rcpp::Module::has_class(), Rcpp::class_Base::name, and Rcpp::class_< Class >::typeinfo_name.

Here is the call graph for this function:

template<typename Class >
Rcpp::class_< Class >::~class_ ( ) [inline]

Definition at line 380 of file Module.h.

template<typename Class >
Rcpp::class_< Class >::class_ ( ) [inline, private]

Definition at line 733 of file Module.h.

Member Function Documentation

template<typename Class >
self& Rcpp::class_< Class >::AddConstructor ( constructor_class *  ctor,
ValidConstructor  valid,
const char *  docstring = 0 
) [inline]

Definition at line 383 of file Module.h.

References Rcpp::class_< Class >::class_pointer, Rcpp::class_< Class >::constructors, and Rcpp::class_Base::docstring.

template<typename Class >
self& Rcpp::class_< Class >::AddMethod ( const char *  name_,
method_class *  m,
ValidMethod  valid = &yes,
const char *  docstring = 0 
) [inline]

Definition at line 498 of file Module.h.

References Rcpp::class_< Class >::class_pointer, Rcpp::class_Base::docstring, push_back(), Rcpp::class_< Class >::specials, and Rcpp::class_< Class >::vec_methods.

Here is the call graph for this function:

template<typename Class >
self& Rcpp::class_< Class >::AddProperty ( const char *  name_,
prop_class *  p 
) [inline]

Definition at line 508 of file Module.h.

References Rcpp::class_< Class >::class_pointer, and Rcpp::class_< Class >::properties.

template<typename Class >
Rcpp::CharacterVector Rcpp::class_< Class >::complete ( ) [inline, virtual]

Reimplemented from Rcpp::class_Base.

Definition at line 625 of file Module.h.

References i, n, Rcpp::class_< Class >::properties, Rcpp::class_< Class >::specials, and Rcpp::class_< Class >::vec_methods.

template<typename Class >
self& Rcpp::class_< Class >::default_constructor ( const char *  docstring = 0,
ValidConstructor  valid = &yes_arity<0> 
) [inline]

Definition at line 388 of file Module.h.

References Rcpp::class_Base::docstring.

template<typename Class >
Rcpp::List Rcpp::class_< Class >::fields ( SEXP  class_xp) [inline, virtual]

Reimplemented from Rcpp::class_Base.

Definition at line 666 of file Module.h.

References i, n, and Rcpp::class_< Class >::properties.

template<typename Class >
self& Rcpp::class_< Class >::finalizer ( void(*)(Class *)  f) [inline]

Definition at line 708 of file Module.h.

References Rcpp::class_< Class >::SetFinalizer().

Referenced by Rcpp::class_< Class >::SetFinalizer().

Here is the call graph for this function:

template<typename Class >
std::string Rcpp::class_< Class >::get_typeinfo_name ( ) [inline, virtual]

Reimplemented from Rcpp::class_Base.

Definition at line 396 of file Module.h.

References Rcpp::class_< Class >::typeinfo_name.

template<typename Class >
Rcpp::List Rcpp::class_< Class >::getConstructors ( SEXP  class_xp,
std::string &  buffer 
) [inline, virtual]

Reimplemented from Rcpp::class_Base.

Definition at line 694 of file Module.h.

References Rcpp::class_< Class >::constructors, i, n, and Rcpp::class_Base::name.

template<typename Class >
Rcpp::List Rcpp::class_< Class >::getMethods ( SEXP  class_xp,
std::string &  buffer 
) [inline, virtual]

Reimplemented from Rcpp::class_Base.

Definition at line 679 of file Module.h.

References i, n, v, and Rcpp::class_< Class >::vec_methods.

template<typename Class >
SEXP Rcpp::class_< Class >::getProperty ( SEXP  field_xp,
SEXP  object 
) [inline, virtual]

Reimplemented from Rcpp::class_Base.

Definition at line 651 of file Module.h.

References BEGIN_RCPP, END_RCPP, and Rcpp::CppProperty< Class >::get().

Here is the call graph for this function:

template<typename Class >
bool Rcpp::class_< Class >::has_default_constructor ( ) [inline, virtual]

Reimplemented from Rcpp::class_Base.

Definition at line 416 of file Module.h.

References Rcpp::class_< Class >::constructors, i, n, Rcpp::SignedConstructor< Class >::nargs(), and p.

Here is the call graph for this function:

template<typename Class >
bool Rcpp::class_< Class >::has_method ( const std::string &  m) [inline, virtual]

Reimplemented from Rcpp::class_Base.

Definition at line 516 of file Module.h.

References Rcpp::class_< Class >::vec_methods.

template<typename Class >
bool Rcpp::class_< Class >::has_property ( const std::string &  m) [inline, virtual]

Reimplemented from Rcpp::class_Base.

Definition at line 519 of file Module.h.

References Rcpp::class_< Class >::properties.

template<typename Class >
SEXP Rcpp::class_< Class >::invoke ( SEXP  method_xp,
SEXP  object,
SEXP *  args,
int  nargs 
) [inline, virtual]

Reimplemented from Rcpp::class_Base.

Definition at line 426 of file Module.h.

References BEGIN_RCPP, END_RCPP, i, Rcpp::CppMethod< Class >::is_void(), and n.

Here is the call graph for this function:

template<typename Class >
SEXP Rcpp::class_< Class >::invoke_notvoid ( SEXP  method_xp,
SEXP  object,
SEXP *  args,
int  nargs 
) [inline, virtual]

Reimplemented from Rcpp::class_Base.

Definition at line 475 of file Module.h.

References BEGIN_RCPP, END_RCPP, i, and n.

template<typename Class >
SEXP Rcpp::class_< Class >::invoke_void ( SEXP  method_xp,
SEXP  object,
SEXP *  args,
int  nargs 
) [inline, virtual]

Reimplemented from Rcpp::class_Base.

Definition at line 453 of file Module.h.

References BEGIN_RCPP, END_RCPP, i, and n.

template<typename Class >
Rcpp::CharacterVector Rcpp::class_< Class >::method_names ( ) [inline, virtual]

Reimplemented from Rcpp::class_Base.

Definition at line 533 of file Module.h.

References i, j, n, Rcpp::class_Base::name, and Rcpp::class_< Class >::vec_methods.

template<typename Class >
Rcpp::IntegerVector Rcpp::class_< Class >::methods_arity ( ) [inline, virtual]

Reimplemented from Rcpp::class_Base.

Definition at line 553 of file Module.h.

References i, j, n, Rcpp::class_Base::name, and Rcpp::class_< Class >::vec_methods.

template<typename Class >
Rcpp::LogicalVector Rcpp::class_< Class >::methods_voidness ( ) [inline, virtual]

Reimplemented from Rcpp::class_Base.

Definition at line 577 of file Module.h.

References i, j, n, Rcpp::class_Base::name, and Rcpp::class_< Class >::vec_methods.

template<typename Class >
SEXP Rcpp::class_< Class >::newInstance ( SEXP *  args,
int  nargs 
) [inline, virtual]

Reimplemented from Rcpp::class_Base.

Definition at line 400 of file Module.h.

References BEGIN_RCPP, Rcpp::class_< Class >::constructors, END_RCPP, i, n, and p.

template<typename Class >
std::string Rcpp::class_< Class >::property_class ( const std::string &  p) [inline, virtual]

Reimplemented from Rcpp::class_Base.

Definition at line 527 of file Module.h.

References Rcpp::class_< Class >::properties.

template<typename Class >
Rcpp::List Rcpp::class_< Class >::property_classes ( ) [inline, virtual]

Reimplemented from Rcpp::class_Base.

Definition at line 612 of file Module.h.

References i, n, and Rcpp::class_< Class >::properties.

template<typename Class >
bool Rcpp::class_< Class >::property_is_readonly ( const std::string &  p) [inline, virtual]

Reimplemented from Rcpp::class_Base.

Definition at line 522 of file Module.h.

References Rcpp::class_< Class >::properties.

template<typename Class >
Rcpp::CharacterVector Rcpp::class_< Class >::property_names ( ) [inline, virtual]

Reimplemented from Rcpp::class_Base.

Definition at line 602 of file Module.h.

References i, n, and Rcpp::class_< Class >::properties.

template<typename Class >
virtual void Rcpp::class_< Class >::run_finalizer ( SEXP  object) [inline, virtual]

Reimplemented from Rcpp::class_Base.

Definition at line 713 of file Module.h.

References Rcpp::class_< Class >::finalizer_pointer, and Rcpp::CppFinalizer< Class >::run().

Here is the call graph for this function:

template<typename Class >
void Rcpp::class_< Class >::SetFinalizer ( finalizer_class *  f) [inline, private]

Definition at line 719 of file Module.h.

References Rcpp::class_< Class >::class_pointer, Rcpp::class_< Class >::finalizer(), and Rcpp::class_< Class >::finalizer_pointer.

Referenced by Rcpp::class_< Class >::finalizer().

Here is the call graph for this function:

template<typename Class >
void Rcpp::class_< Class >::setProperty ( SEXP  field_xp,
SEXP  object,
SEXP  value 
) [inline, virtual]

Reimplemented from Rcpp::class_Base.

Definition at line 658 of file Module.h.

References BEGIN_RCPP, Rcpp::CppProperty< Class >::set(), and VOID_END_RCPP.

Here is the call graph for this function:

Member Data Documentation

template<typename Class >
self* Rcpp::class_< Class >::class_pointer [private]

Definition at line 730 of file Module.h.

Referenced by Rcpp::class_< Class >::AddConstructor(), Rcpp::class_< Class >::AddMethod(), Rcpp::class_< Class >::AddProperty(), Rcpp::class_< Class >::class_(), and Rcpp::class_< Class >::SetFinalizer().

template<typename Class >
vec_signed_constructor Rcpp::class_< Class >::constructors [private]

Definition at line 729 of file Module.h.

Referenced by Rcpp::class_< Class >::AddConstructor(), Rcpp::class_< Class >::getConstructors(), Rcpp::class_< Class >::has_default_constructor(), and Rcpp::class_< Class >::newInstance().

template<typename Class >
finalizer_class* Rcpp::class_< Class >::finalizer_pointer [private]

Definition at line 727 of file Module.h.

Referenced by Rcpp::class_< Class >::class_(), Rcpp::class_< Class >::run_finalizer(), and Rcpp::class_< Class >::SetFinalizer().

template<typename Class >
PROPERTY_MAP Rcpp::class_< Class >::properties [private]

Definition at line 725 of file Module.h.

Referenced by Rcpp::class_< Class >::AddProperty(), Rcpp::class_< Class >::complete(), Rcpp::class_< Class >::fields(), Rcpp::class_< Class >::has_property(), Rcpp::class_< Class >::property_class(), Rcpp::class_< Class >::property_classes(), Rcpp::class_< Class >::property_is_readonly(), and Rcpp::class_< Class >::property_names().

template<typename Class >
int Rcpp::class_< Class >::specials [private]

Definition at line 728 of file Module.h.

Referenced by Rcpp::class_< Class >::AddMethod(), and Rcpp::class_< Class >::complete().

template<typename Class >
std::string Rcpp::class_< Class >::typeinfo_name [private]

Definition at line 731 of file Module.h.

Referenced by Rcpp::class_< Class >::class_(), and Rcpp::class_< Class >::get_typeinfo_name().

template<typename Class >
map_vec_signed_method Rcpp::class_< Class >::vec_methods [private]

Definition at line 724 of file Module.h.

Referenced by Rcpp::class_< Class >::AddMethod(), Rcpp::class_< Class >::complete(), Rcpp::class_< Class >::getMethods(), Rcpp::class_< Class >::has_method(), Rcpp::class_< Class >::method_names(), Rcpp::class_< Class >::methods_arity(), and Rcpp::class_< Class >::methods_voidness().

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerator Friends Defines