Rcpp Version 1.0.0
Rcpp::attributes::Attribute Class Reference

Public Member Functions

 Attribute ()
 
 Attribute (const std::string &name, const std::vector< Param > &params, const Function &function, const std::vector< std::string > &roxygen)
 
bool empty () const
 
bool operator== (const Attribute &other) const
 
bool operator!= (const Attribute &other) const
 
const std::string & name () const
 
const std::vector< Param > & params () const
 
Param paramNamed (const std::string &name) const
 
bool hasParameter (const std::string &name) const
 
const Functionfunction () const
 
bool isExportedFunction () const
 
std::string exportedName () const
 
std::string exportedCppName () const
 
bool rng () const
 
const std::vector< std::string > & roxygen () const
 

Private Attributes

std::string name_
 
std::vector< Paramparams_
 
Function function_
 
std::vector< std::string > roxygen_
 

Detailed Description

Definition at line 310 of file attributes.cpp.

Constructor & Destructor Documentation

◆ Attribute() [1/2]

Rcpp::attributes::Attribute::Attribute ( )
inline

Definition at line 312 of file attributes.cpp.

◆ Attribute() [2/2]

Rcpp::attributes::Attribute::Attribute ( const std::string &  name,
const std::vector< Param > &  params,
const Function function,
const std::vector< std::string > &  roxygen 
)
inline

Definition at line 313 of file attributes.cpp.

Member Function Documentation

◆ empty()

bool Rcpp::attributes::Attribute::empty ( ) const
inline

Definition at line 321 of file attributes.cpp.

Referenced by Rcpp::attributes::operator<<().

◆ exportedCppName()

std::string Rcpp::attributes::Attribute::exportedCppName ( ) const
inline

Definition at line 369 of file attributes.cpp.

◆ exportedName()

std::string Rcpp::attributes::Attribute::exportedName ( ) const
inline

◆ function()

◆ hasParameter()

bool Rcpp::attributes::Attribute::hasParameter ( const std::string &  name) const
inline

Definition at line 341 of file attributes.cpp.

References Rcpp::attributes::Param::empty().

Here is the call graph for this function:

◆ isExportedFunction()

bool Rcpp::attributes::Attribute::isExportedFunction ( ) const
inline

◆ name()

const std::string& Rcpp::attributes::Attribute::name ( ) const
inline

Definition at line 335 of file attributes.cpp.

Referenced by Rcpp::attributes::operator<<().

◆ operator!=()

bool Rcpp::attributes::Attribute::operator!= ( const Attribute other) const
inline

Definition at line 330 of file attributes.cpp.

◆ operator==()

bool Rcpp::attributes::Attribute::operator== ( const Attribute other) const
inline

Definition at line 323 of file attributes.cpp.

References function_, name_, params_, and roxygen_.

◆ paramNamed()

Param Rcpp::attributes::Attribute::paramNamed ( const std::string &  name) const

Definition at line 1040 of file attributes.cpp.

◆ params()

const std::vector<Param>& Rcpp::attributes::Attribute::params ( ) const
inline

Definition at line 337 of file attributes.cpp.

Referenced by Rcpp::attributes::operator<<().

◆ rng()

bool Rcpp::attributes::Attribute::rng ( ) const
inline

Definition at line 375 of file attributes.cpp.

References Rcpp::attributes::Param::empty(), Rcpp::attributes::kParamValueTRUE, and Rcpp::attributes::Param::value().

Referenced by Rcpp::attributes::generateCpp().

Here is the call graph for this function:

◆ roxygen()

const std::vector<std::string>& Rcpp::attributes::Attribute::roxygen ( ) const
inline

Member Data Documentation

◆ function_

Function Rcpp::attributes::Attribute::function_
private

Definition at line 389 of file attributes.cpp.

Referenced by operator==().

◆ name_

std::string Rcpp::attributes::Attribute::name_
private

Definition at line 387 of file attributes.cpp.

Referenced by operator==().

◆ params_

std::vector<Param> Rcpp::attributes::Attribute::params_
private

Definition at line 388 of file attributes.cpp.

Referenced by operator==().

◆ roxygen_

std::vector<std::string> Rcpp::attributes::Attribute::roxygen_
private

Definition at line 390 of file attributes.cpp.

Referenced by operator==().


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