InterrogateFunctionWrapper Class Reference

An internal representation of a callable function. More...

#include "interrogateFunctionWrapper.h"

Inheritance diagram for InterrogateFunctionWrapper:

Classes
class	Parameter

Public Member Functions
	InterrogateFunctionWrapper (const InterrogateFunctionWrapper &copy)
	InterrogateFunctionWrapper (InterrogateModuleDef *def=nullptr)
bool	caller_manages_return_value () const
const std::string &	get_comment () const
FunctionIndex	get_function () const
	Returns the FunctionIndex of the function that this wrapper corresponds to.
TypeIndex	get_return_type () const
FunctionIndex	get_return_value_destructor () const
const std::string &	get_unique_name () const
bool	has_comment () const
bool	has_return_value () const
void	input (std::istream &in)
	Reads the data file as previously formatted by output().
bool	is_callable_by_name () const
bool	is_coerce_constructor () const
bool	is_copy_constructor () const
bool	is_extension () const
int	number_of_parameters () const
void	operator= (const InterrogateFunctionWrapper &copy)
void	output (std::ostream &out) const
	Formats the InterrogateFunctionWrapper data for output to a data file.
const std::string &	parameter_get_name (int n) const
TypeIndex	parameter_get_type (int n) const
bool	parameter_has_name (int n) const
bool	parameter_is_optional (int n) const
bool	parameter_is_this (int n) const
void	remap_indices (const IndexRemapper &remap)
	Remaps all internal index numbers according to the indicated map.
Public Member Functions inherited from InterrogateComponent
	InterrogateComponent (const InterrogateComponent &copy)
	InterrogateComponent (InterrogateModuleDef *def=nullptr)
const std::string &	get_alt_name (int n) const
const char *	get_library_name () const
	Returns the library name, if it is known, or NULL if it is not.
const char *	get_module_name () const
	Returns the module name, if it is known, or NULL if it is not.
const std::string &	get_name () const
int	get_num_alt_names () const
bool	has_library_name () const
	Returns true if we have a known library name, false if we do not.
bool	has_module_name () const
	Returns true if we have a known module name, false if we do not.
bool	has_name () const
void	input (std::istream &in)
	Reads the data file as previously formatted by output().
void	operator= (const InterrogateComponent &copy)
void	output (std::ostream &out) const
	Formats the component for output to a data file.

Friends
class	FunctionRemap
class	InterrogateBuilder

Detailed Description

An internal representation of a callable function.

Definition at line 28 of file interrogateFunctionWrapper.h.

Constructor & Destructor Documentation

InterrogateFunctionWrapper() [1/2]

InterrogateFunctionWrapper::InterrogateFunctionWrapper ( InterrogateModuleDef * def = nullptr )

inline

Definition at line 17 of file interrogateFunctionWrapper.I.

InterrogateFunctionWrapper() [2/2]

InterrogateFunctionWrapper::InterrogateFunctionWrapper ( const InterrogateFunctionWrapper & copy )

inline

Definition at line 30 of file interrogateFunctionWrapper.I.

Member Function Documentation

caller_manages_return_value()

bool InterrogateFunctionWrapper::caller_manages_return_value ( ) const

inline

Definition at line 109 of file interrogateFunctionWrapper.I.

get_comment()

const std::string & InterrogateFunctionWrapper::get_comment ( ) const

inline

Definition at line 205 of file interrogateFunctionWrapper.I.

get_function()

FunctionIndex InterrogateFunctionWrapper::get_function ( ) const

inline

Returns the FunctionIndex of the function that this wrapper corresponds to.

Definition at line 53 of file interrogateFunctionWrapper.I.

get_return_type()

TypeIndex InterrogateFunctionWrapper::get_return_type ( ) const

inline

Definition at line 101 of file interrogateFunctionWrapper.I.

get_return_value_destructor()

FunctionIndex InterrogateFunctionWrapper::get_return_value_destructor ( ) const

inline

Definition at line 117 of file interrogateFunctionWrapper.I.

get_unique_name()

const std::string & InterrogateFunctionWrapper::get_unique_name ( ) const

inline

Definition at line 189 of file interrogateFunctionWrapper.I.

has_comment()

bool InterrogateFunctionWrapper::has_comment ( ) const

inline

Definition at line 197 of file interrogateFunctionWrapper.I.

has_return_value()

bool InterrogateFunctionWrapper::has_return_value ( ) const

inline

Definition at line 93 of file interrogateFunctionWrapper.I.

input()

void InterrogateFunctionWrapper::input

(

std::istream &

in

)

Reads the data file as previously formatted by output().

Definition at line 59 of file interrogateFunctionWrapper.cxx.

References idf_input_string(), idf_input_vector(), and InterrogateComponent::input().

is_callable_by_name()

bool InterrogateFunctionWrapper::is_callable_by_name ( ) const

inline

Definition at line 61 of file interrogateFunctionWrapper.I.

is_coerce_constructor()

bool InterrogateFunctionWrapper::is_coerce_constructor ( ) const

inline

Since

1.10.13

Definition at line 77 of file interrogateFunctionWrapper.I.

is_copy_constructor()

bool InterrogateFunctionWrapper::is_copy_constructor ( ) const

inline

Since

1.10.13

Definition at line 69 of file interrogateFunctionWrapper.I.

is_extension()

bool InterrogateFunctionWrapper::is_extension ( ) const

inline

Since

1.10.13

Definition at line 85 of file interrogateFunctionWrapper.I.

number_of_parameters()

int InterrogateFunctionWrapper::number_of_parameters ( ) const

inline

Definition at line 125 of file interrogateFunctionWrapper.I.

operator=()

void InterrogateFunctionWrapper::operator= ( const InterrogateFunctionWrapper & copy )

inline

Definition at line 38 of file interrogateFunctionWrapper.I.

output()

void InterrogateFunctionWrapper::output

(

std::ostream &

out

)

const

Formats the InterrogateFunctionWrapper data for output to a data file.

Definition at line 44 of file interrogateFunctionWrapper.cxx.

References idf_output_string(), idf_output_vector(), and InterrogateComponent::output().

parameter_get_name()

const std::string & InterrogateFunctionWrapper::parameter_get_name ( int n ) const

inline

Definition at line 155 of file interrogateFunctionWrapper.I.

parameter_get_type()

TypeIndex InterrogateFunctionWrapper::parameter_get_type ( int n ) const

inline

Definition at line 133 of file interrogateFunctionWrapper.I.

parameter_has_name()

bool InterrogateFunctionWrapper::parameter_has_name ( int n ) const

inline

Definition at line 144 of file interrogateFunctionWrapper.I.

parameter_is_optional()

bool InterrogateFunctionWrapper::parameter_is_optional ( int n ) const

inline

Definition at line 178 of file interrogateFunctionWrapper.I.

parameter_is_this()

bool InterrogateFunctionWrapper::parameter_is_this ( int n ) const

inline

Definition at line 167 of file interrogateFunctionWrapper.I.

remap_indices()

void InterrogateFunctionWrapper::remap_indices

(

const IndexRemapper &

remap

)

Remaps all internal index numbers according to the indicated map.

This called from InterrogateDatabase::remap_indices().

Definition at line 75 of file interrogateFunctionWrapper.cxx.

References IndexRemapper::map_from().

Friends And Related Symbol Documentation

FunctionRemap

friend class FunctionRemap

friend

Definition at line 105 of file interrogateFunctionWrapper.h.

InterrogateBuilder

friend class InterrogateBuilder

friend

Definition at line 104 of file interrogateFunctionWrapper.h.

---

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

• dtool/src/interrogatedb/interrogateFunctionWrapper.h
• dtool/src/interrogatedb/interrogateFunctionWrapper.cxx
• dtool/src/interrogatedb/interrogateFunctionWrapper.I