eigenpy::deprecation_warning_policy< deprecation_type, BasePolicy > Struct Template Reference

A Boost.Python call policy which triggers a Python warning on precall. More...

#include <eigenpy/deprecation-policy.hpp>

Inheritance diagram for eigenpy::deprecation_warning_policy< deprecation_type, BasePolicy >:

Collaboration diagram for eigenpy::deprecation_warning_policy< deprecation_type, BasePolicy >:

Public Types
using	result_converter = typename BasePolicy::result_converter
using	argument_package = typename BasePolicy::argument_package

Public Member Functions
	deprecation_warning_policy (const std::string &warning_msg)
std::string	what () const
const BasePolicy *	derived () const
template<class ArgPackage>
bool	precall (const ArgPackage &args) const

Protected Attributes
const std::string	m_what

Detailed Description

template<DeprecationType deprecation_type = DeprecationType::DEPRECATION, class BasePolicy = bp::default_call_policies>
struct eigenpy::deprecation_warning_policy< deprecation_type, BasePolicy >

A Boost.Python call policy which triggers a Python warning on precall.

Definition at line 35 of file deprecation-policy.hpp.

Member Typedef Documentation

argument_package

template<DeprecationType deprecation_type = DeprecationType::DEPRECATION, class BasePolicy = bp::default_call_policies>

using eigenpy::deprecation_warning_policy< deprecation_type, BasePolicy >::argument_package = typename BasePolicy::argument_package

Definition at line 37 of file deprecation-policy.hpp.

result_converter

template<DeprecationType deprecation_type = DeprecationType::DEPRECATION, class BasePolicy = bp::default_call_policies>

using eigenpy::deprecation_warning_policy< deprecation_type, BasePolicy >::result_converter = typename BasePolicy::result_converter

Definition at line 36 of file deprecation-policy.hpp.

Constructor & Destructor Documentation

deprecation_warning_policy()

template<DeprecationType deprecation_type = DeprecationType::DEPRECATION, class BasePolicy = bp::default_call_policies>

eigenpy::deprecation_warning_policy< deprecation_type, BasePolicy >::deprecation_warning_policy ( const std::string & warning_msg )

inline

Definition at line 39 of file deprecation-policy.hpp.

Member Function Documentation

derived()

template<DeprecationType deprecation_type = DeprecationType::DEPRECATION, class BasePolicy = bp::default_call_policies>

const BasePolicy * eigenpy::deprecation_warning_policy< deprecation_type, BasePolicy >::derived ( ) const

inline

Definition at line 44 of file deprecation-policy.hpp.

precall()

template<DeprecationType deprecation_type = DeprecationType::DEPRECATION, class BasePolicy = bp::default_call_policies>

template<class ArgPackage>

bool eigenpy::deprecation_warning_policy< deprecation_type, BasePolicy >::precall ( const ArgPackage & args ) const

inline

Definition at line 49 of file deprecation-policy.hpp.

what()

template<DeprecationType deprecation_type = DeprecationType::DEPRECATION, class BasePolicy = bp::default_call_policies>

std::string eigenpy::deprecation_warning_policy< deprecation_type, BasePolicy >::what ( ) const

inline

Definition at line 42 of file deprecation-policy.hpp.

Member Data Documentation

m_what

template<DeprecationType deprecation_type = DeprecationType::DEPRECATION, class BasePolicy = bp::default_call_policies>

const std::string eigenpy::deprecation_warning_policy< deprecation_type, BasePolicy >::m_what

protected

Definition at line 56 of file deprecation-policy.hpp.

---

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

• include/eigenpy/deprecation-policy.hpp