Foundry::Katana::FnAttributeFunctionUtil Class Reference

Provides access to registered AttributeFunction plugins. More...

#include <FnAttributeFunctionUtil.h>

List of all members.

Static Public Member Functions
static FnAttribute::Attribute	run (const std::string &fncName, FnAttribute::Attribute args)
	Runs the AttributeFunction with the specified function name.
static void	getRegisteredFunctionNames (std::vector< std::string > &names)
	Gets the list of registered AttributeFunction names that can be invoked via run().

---

Detailed Description

Provides access to registered AttributeFunction plugins.

---

Member Function Documentation

static void Foundry::Katana::FnAttributeFunctionUtil::getRegisteredFunctionNames

(

std::vector< std::string > &

names

)

[static]

Gets the list of registered AttributeFunction names that can be invoked via run().

Parameters:

names

A vector that will be filled with the AttributeFunction names.

See also:

FnAttributeFunctionUtil::run()

static FnAttribute::Attribute Foundry::Katana::FnAttributeFunctionUtil::run	(	const std::string &	fncName,
		FnAttribute::Attribute	args
	)		[static]

Runs the AttributeFunction with the specified function name.

AttributeFunction plugins are simple plugins which take an FnAttribute instance as input and return an FnAttribute. They are a means of exposing functionality implemented in other plugins across Katana reducing coupling on other modules.

AttributeFunctions can be accessed C++, Lua and Python.

Parameters:

fncName	The name of the AttributeFunction to run.
args	An FnAttribute instance encapsulating the arguments pass to the AttributeFunction.

Returns:

An FnAttribute instance.

---

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

• FnAttributeFunctionUtil.h