ug4
ug::bridge::ExportedMethodGroup Class Reference

Groups of methods - useful to realize overloaded methods. More...

#include <class.h>

Classes

struct  Overload
 

Public Member Functions

template<class TFunc >
bool add_overload (const TFunc &m, ProxyFunc pf, const std::string &className, const std::string &methodOptions, const std::string &retValInfos, const std::string &paramInfos, const std::string &tooltip, const std::string &help)
 adds an overload. Returns false if the overload already existed. More...
 
 ExportedMethodGroup (const std::string &name)
 
ExportedMethodget_overload (size_t index)
 
const ExportedMethodget_overload (size_t index) const
 
template<class TType >
ExportedMethodget_overload_by_type ()
 
template<class TType >
const ExportedMethodget_overload_by_type () const
 
ExportedMethodget_overload_by_type_id (size_t typeID)
 
const ExportedMethodget_overload_by_type_id (size_t typeID) const
 
size_t get_overload_type_id (size_t index) const
 
const std::string & name () const
 name of function group More...
 
size_t num_overloads () const
 
 ~ExportedMethodGroup ()
 

Private Types

typedef ExportedMethod::ProxyFunc ProxyFunc
 

Private Attributes

std::string m_name
 
std::vector< Overloadm_overloads
 

Detailed Description

Groups of methods - useful to realize overloaded methods.

Member Typedef Documentation

◆ ProxyFunc

typedef ExportedMethod::ProxyFunc ug::bridge::ExportedMethodGroup::ProxyFunc
private

Constructor & Destructor Documentation

◆ ExportedMethodGroup()

ug::bridge::ExportedMethodGroup::ExportedMethodGroup ( const std::string &  name)
inline

◆ ~ExportedMethodGroup()

ug::bridge::ExportedMethodGroup::~ExportedMethodGroup ( )
inline

References m_overloads.

Member Function Documentation

◆ add_overload()

template<class TFunc >
bool ug::bridge::ExportedMethodGroup::add_overload ( const TFunc &  m,
ProxyFunc  pf,
const std::string &  className,
const std::string &  methodOptions,
const std::string &  retValInfos,
const std::string &  paramInfos,
const std::string &  tooltip,
const std::string &  help 
)
inline

adds an overload. Returns false if the overload already existed.

References func(), get_overload_by_type_id(), m_name, and m_overloads.

Referenced by ug::bridge::ExportedClass< TClass >::add_method().

◆ get_overload() [1/2]

ExportedMethod* ug::bridge::ExportedMethodGroup::get_overload ( size_t  index)
inline

◆ get_overload() [2/2]

const ExportedMethod* ug::bridge::ExportedMethodGroup::get_overload ( size_t  index) const
inline

References m_overloads.

◆ get_overload_by_type() [1/2]

template<class TType >
ExportedMethod* ug::bridge::ExportedMethodGroup::get_overload_by_type ( )
inline

◆ get_overload_by_type() [2/2]

template<class TType >
const ExportedMethod* ug::bridge::ExportedMethodGroup::get_overload_by_type ( ) const
inline

◆ get_overload_by_type_id() [1/2]

ExportedMethod* ug::bridge::ExportedMethodGroup::get_overload_by_type_id ( size_t  typeID)
inline

References m_overloads.

Referenced by add_overload(), and get_overload_by_type().

◆ get_overload_by_type_id() [2/2]

const ExportedMethod* ug::bridge::ExportedMethodGroup::get_overload_by_type_id ( size_t  typeID) const
inline

References m_overloads.

◆ get_overload_type_id()

size_t ug::bridge::ExportedMethodGroup::get_overload_type_id ( size_t  index) const
inline

References m_overloads.

◆ name()

const std::string& ug::bridge::ExportedMethodGroup::name ( ) const
inline

◆ num_overloads()

size_t ug::bridge::ExportedMethodGroup::num_overloads ( ) const
inline

Member Data Documentation

◆ m_name

std::string ug::bridge::ExportedMethodGroup::m_name
private

Referenced by add_overload(), and name().

◆ m_overloads

std::vector<Overload> ug::bridge::ExportedMethodGroup::m_overloads
private

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