apex::APEX_GenericFunction< C, Ts > Class Template Reference

#include <APEX_Callback.h>

Inheritance diagram for apex::APEX_GenericFunction< C, Ts >:

Public Member Functions
	APEX_GenericFunction ()
	~APEX_GenericFunction () override
const UT_StringHolder &	getName () const override
const APEX_Signature &	signature () const override
APEX_CallbackType	callbackType () const override
	What kind of function is this? Informs things like scopes & conditions. More...
const Dict &	parmDefaults () const override
void	addSparePort (const UT_StringRef &name="", exint index=-1)
bool	addInputAlias (const UT_StringRef &name, const UT_StringRef &alias)
bool	addOutputAlias (const UT_StringRef &name, const UT_StringRef &alias)
void	execute (APEX_ArgPtrs &arg_ptrs) const override
Public Member Functions inherited from apex::APEX_FunctionBase
virtual	~APEX_FunctionBase ()=default
virtual void	compile (const APEX_Graph *graph, APEX_NodeID node_id, APEX_Program *prog, UT_Array< APEX_Argument > &args) const
virtual const APEX_TypeDefinitionBase *	runDataTypeDef () const
virtual const char *	minProductVersion () const
	Earliest Houdini version that this callback is allowed in "X.Y.Z" format. More...
virtual bool	isHidden () const
	Determines whether the callback should be hidden from the UI. More...
virtual bool	requiresCEFlush () const
	Whether the callback requires its input geometry CE caches to be flushed. More...
virtual bool	usesCE () const
	Whether the callback leaves CE caches in its output geometry. More...
virtual void	runDataCompileHook (APEX_Argument *rundata_instance, const APEX_Graph *in_graph, APEX_NodeID for_node, APEX_Program *bind_to) const
	Called for any type with rundata with a reference to the rundata so it can be initialized. More...
bool	opensScope () const
	Does this node open a scope? More...
bool	closesScope () const
	Does this node close a scope? More...
virtual UT_StringHolder	scopeConnection () const
	Name of the fake wire which is used to denote scope relationships. More...
virtual bool	hasSubnetTemplate () const

Static Public Attributes
static constexpr const char *	parm_defaults = ""

Protected Attributes
UT_StringHolder	myName

Detailed Description

template<typename C, typename... Ts>
class apex::APEX_GenericFunction< C, Ts >

Examples:

APEX/apex_external_test.C.

Definition at line 549 of file APEX_Callback.h.

Constructor & Destructor Documentation

template<typename C , typename... Ts>

apex::APEX_GenericFunction< C, Ts >::APEX_GenericFunction ( )

inline

Definition at line 552 of file APEX_Callback.h.

template<typename C , typename... Ts>

apex::APEX_GenericFunction< C, Ts >::~APEX_GenericFunction ( )

inlineoverride

Definition at line 562 of file APEX_Callback.h.

Member Function Documentation

template<typename C , typename... Ts>

bool apex::APEX_GenericFunction< C, Ts >::addInputAlias ( const UT_StringRef &  name, const UT_StringRef &  alias  )

inline

Definition at line 579 of file APEX_Callback.h.

template<typename C , typename... Ts>

bool apex::APEX_GenericFunction< C, Ts >::addOutputAlias ( const UT_StringRef &  name, const UT_StringRef &  alias  )

inline

Definition at line 584 of file APEX_Callback.h.

template<typename C , typename... Ts>

void apex::APEX_GenericFunction< C, Ts >::addSparePort ( const UT_StringRef &  name = "", exint  index = -1  )

inline

Definition at line 574 of file APEX_Callback.h.

template<typename C , typename... Ts>

APEX_CallbackType apex::APEX_GenericFunction< C, Ts >::callbackType ( ) const

inlineoverridevirtual

What kind of function is this? Informs things like scopes & conditions.

Reimplemented from apex::APEX_FunctionBase.

Definition at line 570 of file APEX_Callback.h.

template<typename C , typename... Ts>

void apex::APEX_GenericFunction< C, Ts >::execute ( APEX_ArgPtrs &  arg_ptrs ) const

inlineoverridevirtual

Reimplemented from apex::APEX_FunctionBase.

Definition at line 589 of file APEX_Callback.h.

template<typename C , typename... Ts>

const UT_StringHolder& apex::APEX_GenericFunction< C, Ts >::getName ( ) const

inlineoverridevirtual

Implements apex::APEX_FunctionBase.

Definition at line 564 of file APEX_Callback.h.

template<typename C , typename... Ts>

const Dict& apex::APEX_GenericFunction< C, Ts >::parmDefaults ( ) const

inlineoverridevirtual

Reimplemented from apex::APEX_FunctionBase.

Definition at line 572 of file APEX_Callback.h.

template<typename C , typename... Ts>

const APEX_Signature& apex::APEX_GenericFunction< C, Ts >::signature ( ) const

inlineoverridevirtual

Implements apex::APEX_FunctionBase.

Definition at line 568 of file APEX_Callback.h.

Member Data Documentation

template<typename C , typename... Ts>

UT_StringHolder apex::APEX_GenericFunction< C, Ts >::myName

protected

Definition at line 601 of file APEX_Callback.h.

template<typename C , typename... Ts>

constexpr const char* apex::APEX_GenericFunction< C, Ts >::parm_defaults = ""

static

Definition at line 566 of file APEX_Callback.h.

---

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

• APEX/APEX_Callback.h