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

#include <APEX_Generic.h>

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

Classes
struct	RunDataT

Public Member Functions
	APEX_GenericFunctionRunData ()
	~APEX_GenericFunctionRunData () override
const UT_StringHolder &	getName () const override
const APEX_TypeDefinitionBase *	runDataTypeDef () const override
void	runDataCompileHook (APEX_Argument *rundata_instance, const APEX_Graph *in_graph, APEX_NodeID for_node, APEX_Program *bind_to) const override
	Called for any type with rundata with a reference to the rundata so it can be initialized. More...
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)
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 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...
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_GenericFunctionRunData< C, Ts >

Examples:

APEX/apex_external_test.C.

Definition at line 102 of file APEX_Generic.h.

Constructor & Destructor Documentation

template<typename C , typename... Ts>

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

inline

Definition at line 105 of file APEX_Generic.h.

template<typename C , typename... Ts>

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

inlineoverride

Definition at line 114 of file APEX_Generic.h.

Member Function Documentation

template<typename C , typename... Ts>

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

inline

Definition at line 149 of file APEX_Generic.h.

template<typename C , typename... Ts>

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

inlineoverridevirtual

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

Reimplemented from apex::APEX_FunctionBase.

Definition at line 145 of file APEX_Generic.h.

template<typename C , typename... Ts>

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

inlineoverridevirtual

Reimplemented from apex::APEX_FunctionBase.

Definition at line 154 of file APEX_Generic.h.

template<typename C , typename... Ts>

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

inlineoverridevirtual

Implements apex::APEX_FunctionBase.

Definition at line 116 of file APEX_Generic.h.

template<typename C , typename... Ts>

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

inlineoverridevirtual

Reimplemented from apex::APEX_FunctionBase.

Definition at line 147 of file APEX_Generic.h.

template<typename C , typename... Ts>

void apex::APEX_GenericFunctionRunData< C, Ts >::runDataCompileHook ( APEX_Argument *  rundata_instance, const APEX_Graph *  in_graph, APEX_NodeID  for_node, APEX_Program *  bind_to  ) const

inlineoverridevirtual

Called for any type with rundata with a reference to the rundata so it can be initialized.

Reimplemented from apex::APEX_FunctionBase.

Definition at line 127 of file APEX_Generic.h.

template<typename C , typename... Ts>

const APEX_TypeDefinitionBase* apex::APEX_GenericFunctionRunData< C, Ts >::runDataTypeDef ( ) const

inlineoverridevirtual

Reimplemented from apex::APEX_FunctionBase.

Definition at line 123 of file APEX_Generic.h.

template<typename C , typename... Ts>

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

inlineoverridevirtual

Implements apex::APEX_FunctionBase.

Definition at line 143 of file APEX_Generic.h.

Member Data Documentation

template<typename C , typename... Ts>

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

protected

Definition at line 166 of file APEX_Generic.h.

template<typename C , typename... Ts>

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

static

Definition at line 118 of file APEX_Generic.h.

---

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

• APEX/APEX_Generic.h