Rcpp Version 1.1.2
Loading...
Searching...
No Matches
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 Function & function () const
bool isExportedFunction () const
std::string exportedName () const
std::string exportedCppName () const
bool rng () const
bool invisible () const
const std::vector< std::string > & roxygen () const
std::string customRSignature () const

Private Attributes

std::string name_
std::vector< Param > params_
Function function_
std::vector< std::string > roxygen_

Detailed Description

Definition at line 314 of file attributes.cpp.

Constructor & Destructor Documentation

◆ Attribute() [1/2]

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

Definition at line 316 of file attributes.cpp.

Referenced by operator!=(), and operator==().

◆ 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 317 of file attributes.cpp.

References function(), function_, name(), name_, params(), params_, roxygen(), and roxygen_.

Here is the call graph for this function:

Member Function Documentation

◆ customRSignature()

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

Definition at line 399 of file attributes.cpp.

References Rcpp::attributes::kExportSignature, paramNamed(), Rcpp::attributes::trimWhitespace(), and Rcpp::attributes::Param::value().

Referenced by Rcpp::attributes::RExportsGenerator::doWriteFunctions().

Here is the call graph for this function:

◆ empty()

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

Definition at line 325 of file attributes.cpp.

References name().

Referenced by exportedName(), and Rcpp::attributes::operator<<().

Here is the call graph for this function:

◆ exportedCppName()

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

Definition at line 373 of file attributes.cpp.

References exportedName(), and name().

Here is the call graph for this function:

◆ exportedName()

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

Definition at line 355 of file attributes.cpp.

References empty(), function(), hasParameter(), Rcpp::attributes::kExportName, Rcpp::attributes::Function::name(), paramNamed(), params(), and Rcpp::attributes::Param::value().

Referenced by Rcpp::attributes::RExportsGenerator::doWriteFunctions(), exportedCppName(), and Rcpp::attributes::CppExportsGenerator::writeEnd().

Here is the call graph for this function:

◆ function()

const Function & Rcpp::attributes::Attribute::function ( ) const
inline

Definition at line 349 of file attributes.cpp.

References function_.

Referenced by Attribute(), Rcpp::attributes::RExportsGenerator::doWriteFunctions(), exportedName(), Rcpp::attributes::generateCpp(), isExportedFunction(), Rcpp::attributes::operator<<(), and Rcpp::attributes::CppExportsGenerator::writeEnd().

◆ hasParameter()

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

Definition at line 345 of file attributes.cpp.

References Rcpp::attributes::Param::empty(), name(), and paramNamed().

Referenced by Rcpp::attributes::RExportsGenerator::doWriteFunctions(), and exportedName().

Here is the call graph for this function:

◆ invisible()

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

Definition at line 388 of file attributes.cpp.

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

Referenced by Rcpp::attributes::RExportsGenerator::doWriteFunctions().

Here is the call graph for this function:

◆ isExportedFunction()

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

Definition at line 351 of file attributes.cpp.

References Rcpp::attributes::Function::empty(), function(), Rcpp::attributes::kExportAttribute, and name().

Referenced by Rcpp::attributes::RExportsGenerator::doWriteFunctions(), and Rcpp::attributes::generateCpp().

Here is the call graph for this function:

◆ name()

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

Definition at line 339 of file attributes.cpp.

References name_.

Referenced by Attribute(), empty(), exportedCppName(), hasParameter(), isExportedFunction(), Rcpp::attributes::operator<<(), and paramNamed().

◆ operator!=()

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

Definition at line 334 of file attributes.cpp.

References Attribute().

Here is the call graph for this function:

◆ operator==()

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

Definition at line 327 of file attributes.cpp.

References Attribute(), function_, name_, params_, and roxygen_.

Here is the call graph for this function:

◆ paramNamed()

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

Definition at line 1074 of file attributes.cpp.

References name(), and params_.

Referenced by customRSignature(), exportedName(), hasParameter(), invisible(), and rng().

Here is the call graph for this function:

◆ params()

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

Definition at line 341 of file attributes.cpp.

References params_.

Referenced by Attribute(), exportedName(), and Rcpp::attributes::operator<<().

◆ rng()

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

Definition at line 379 of file attributes.cpp.

References Rcpp::attributes::Param::empty(), Rcpp::attributes::kExportRng, Rcpp::attributes::kParamValueTRUE, Rcpp::attributes::kParamValueTrue, paramNamed(), 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

Definition at line 397 of file attributes.cpp.

References roxygen_.

Referenced by Attribute(), and Rcpp::attributes::RExportsGenerator::doWriteFunctions().

Member Data Documentation

◆ function_

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

Definition at line 416 of file attributes.cpp.

Referenced by Attribute(), function(), and operator==().

◆ name_

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

Definition at line 414 of file attributes.cpp.

Referenced by Attribute(), name(), and operator==().

◆ params_

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

Definition at line 415 of file attributes.cpp.

Referenced by Attribute(), operator==(), paramNamed(), and params().

◆ roxygen_

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

Definition at line 417 of file attributes.cpp.

Referenced by Attribute(), operator==(), and roxygen().

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