ug::bridge::ExportedFunctionBase Class Reference

Base class for function/method export. More...

#include <global_function.h>

Inheritance diagram for ug::bridge::ExportedFunctionBase:

Public Member Functions
bool	check_consistency (std::string classname="") const
	returns true if all parameters of the function are correctly declared
	ExportedFunctionBase (const std::string &funcName, const std::string &funcOptions, const std::string &retValInfos, const std::string &paramInfos, const std::string &tooltip, const std::string &help)
const std::string &	help () const
	help informations
const std::string &	name () const
	name of function
size_t	num_infos (size_t i) const
	number of info strings for one parameter
size_t	num_parameter () const
	number of parameters.
const std::string &	options () const
	name of function
const char *	parameter_class_name (size_t i) const
	class name of parameter i
const std::string &	parameter_info (size_t i, size_t j) const
	type info of all parameters
const std::string &	parameter_info_string () const
	whole string of all type infos for of all parameters
const std::vector< std::string > &	parameter_info_vec (size_t i) const
	type info of i th parameters
const std::string &	parameter_name (size_t i) const
	name of parameter i
ParameterInfo &	params_in ()
	non-const export of param list
const ParameterInfo &	params_in () const
	parameter list for input values
const ParameterInfo &	params_out () const
	parameter list for input values
const std::string &	return_info (size_t i) const
	type info of return type
const std::vector< std::string > &	return_info_vec () const
	type info of return value
const std::string &	return_name () const
	name of return value
const std::string &	tooltip () const
	gives some information to the exported functions

Protected Member Functions
template<typename TFunc >
void	create_parameter_stack ()
void	tokenize (const std::string &str, std::vector< std::string > &tokens, const char delimiter)

Protected Attributes
std::string	m_help
std::string	m_methodOptions
std::string	m_name
std::string	m_paramInfos
ParameterInfo	m_paramsIn
ParameterInfo	m_paramsOut
std::string	m_retValInfos
std::string	m_tooltip
std::vector< std::string >	m_vRetValInfo
std::vector< std::vector< std::string > >	m_vvParamInfo

Detailed Description

Base class for function/method export.

Constructor & Destructor Documentation

ExportedFunctionBase()

ug::bridge::ExportedFunctionBase::ExportedFunctionBase	(	const std::string &	funcName,
		const std::string &	funcOptions,
		const std::string &	retValInfos,
		const std::string &	paramInfos,
		const std::string &	tooltip,
		const std::string &	help
	)

References m_name, m_paramInfos, m_retValInfos, m_vRetValInfo, m_vvParamInfo, tokenize(), UG_ERR_LOG, and UG_THROW_REGISTRY_ERROR.

Member Function Documentation

check_consistency()

bool ug::bridge::ExportedFunctionBase::check_consistency

(

std::string

classname = ""

)

const

returns true if all parameters of the function are correctly declared

References name(), num_parameter(), parameter_name(), ug::bridge::ParameterInfo::parameter_named(), ug::bridge::ParameterToString(), params_in(), params_out(), ug::bridge::ParameterInfo::size(), and UG_ERR_LOG.

Referenced by ug::bridge::Registry::check_consistency().

create_parameter_stack()

template<typename TFunc >

void ug::bridge::ExportedFunctionBase::create_parameter_stack ( )

inlineprotected

help()

const std::string & ug::bridge::ExportedFunctionBase::help ( ) const

inline

help informations

Referenced by ug::bridge::FunctionInfo(), and ug::vrl::method2NativeMethod().

name()

const std::string & ug::bridge::ExportedFunctionBase::name ( ) const

inline

name of function

Referenced by check_consistency(), ug::bridge::FindFunction(), ug::bridge::FunctionInfo(), ug::bridge::lua::GetBestMatchingMember(), ug::bridge::GetMemberFunctionCompletitions(), ug::bridge::GetMemberFunctionInfo(), and ug::vrl::method2NativeMethod().

num_infos()

size_t ug::bridge::ExportedFunctionBase::num_infos ( size_t  i ) const

inline

number of info strings for one parameter

num_parameter()

size_t ug::bridge::ExportedFunctionBase::num_parameter ( ) const

inline

number of parameters.

Referenced by check_consistency().

options()

const std::string & ug::bridge::ExportedFunctionBase::options ( ) const

inline

name of function

Referenced by ug::vrl::method2NativeMethod().

parameter_class_name()

const char * ug::bridge::ExportedFunctionBase::parameter_class_name ( size_t  i ) const

inline

class name of parameter i

parameter_info()

const std::string & ug::bridge::ExportedFunctionBase::parameter_info ( size_t  i, size_t  j  ) const

inline

type info of all parameters

parameter_info_string()

const std::string & ug::bridge::ExportedFunctionBase::parameter_info_string ( ) const

inline

whole string of all type infos for of all parameters

parameter_info_vec()

const std::vector< std::string > & ug::bridge::ExportedFunctionBase::parameter_info_vec ( size_t  i ) const

inline

type info of i th parameters

parameter_name()

const std::string & ug::bridge::ExportedFunctionBase::parameter_name ( size_t  i ) const

inline

name of parameter i

Referenced by check_consistency().

params_in() [1/2]

ParameterInfo & ug::bridge::ExportedFunctionBase::params_in ( )

inline

non-const export of param list

params_in() [2/2]

const ParameterInfo & ug::bridge::ExportedFunctionBase::params_in ( ) const

inline

parameter list for input values

Referenced by check_consistency(), ug::bridge::ClassUsageExact(), ug::bridge::lua::ExecuteMethod(), ug::vrl::invocation::getMethodBySignature(), and Java_edu_gcsc_vrl_ug_UG__1invokeMethod().

params_out()

const ParameterInfo & ug::bridge::ExportedFunctionBase::params_out ( ) const

inline

parameter list for input values

Referenced by check_consistency(), ug::bridge::ClassUsageExact(), and ug::bridge::PrintParametersOut().

return_info()

const std::string & ug::bridge::ExportedFunctionBase::return_info ( size_t  i ) const

inline

type info of return type

return_info_vec()

const std::vector< std::string > & ug::bridge::ExportedFunctionBase::return_info_vec ( ) const

inline

type info of return value

return_name()

const std::string & ug::bridge::ExportedFunctionBase::return_name ( ) const

inline

name of return value

tokenize()

void ug::bridge::ExportedFunctionBase::tokenize ( const std::string &  str, std::vector< std::string > &  tokens, const char  delimiter  )

protected

References ug::TrimString().

Referenced by ExportedFunctionBase().

tooltip()

const std::string & ug::bridge::ExportedFunctionBase::tooltip ( ) const

inline

gives some information to the exported functions

Referenced by ug::bridge::FunctionInfo().

Member Data Documentation

m_help

std::string ug::bridge::ExportedFunctionBase::m_help

protected

m_methodOptions

std::string ug::bridge::ExportedFunctionBase::m_methodOptions

protected

m_name

std::string ug::bridge::ExportedFunctionBase::m_name

protected

Referenced by ExportedFunctionBase().

m_paramInfos

std::string ug::bridge::ExportedFunctionBase::m_paramInfos

protected

Referenced by ExportedFunctionBase().

m_paramsIn

ParameterInfo ug::bridge::ExportedFunctionBase::m_paramsIn

protected

m_paramsOut

ParameterInfo ug::bridge::ExportedFunctionBase::m_paramsOut

protected

m_retValInfos

std::string ug::bridge::ExportedFunctionBase::m_retValInfos

protected

Referenced by ExportedFunctionBase().

m_tooltip

std::string ug::bridge::ExportedFunctionBase::m_tooltip

protected

m_vRetValInfo

std::vector<std::string> ug::bridge::ExportedFunctionBase::m_vRetValInfo

protected

Referenced by ExportedFunctionBase().

m_vvParamInfo

std::vector<std::vector<std::string> > ug::bridge::ExportedFunctionBase::m_vvParamInfo

protected

Referenced by ExportedFunctionBase().

---

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

• ugbase/registry/global_function.h
• ugbase/registry/global_function.cpp