Arcane::IExternalPlugin Class Reference

Interface for external service loading. More...

#include <arcane/core/IExternalPlugin.h>

Collaboration diagram for Arcane::IExternalPlugin:

Public Member Functions
virtual	~IExternalPlugin ()=default
	Releases resources.
virtual void	loadFile (const String &filename)=0
	Loads and executes a file containing an external script.
virtual void	executeFunction (const String &function_name)=0
	Executes the function function_name.
virtual void	executeContextFunction (const String &function_name)=0
	Executes the function function_name with a context.

Detailed Description

Interface for external service loading.

Warning

This interface is experimental.

You must call loadFile() (possibly with an empty string) to initialize the instance.

Definition at line 36 of file IExternalPlugin.h.

Member Function Documentation

executeContextFunction()

virtual void Arcane::IExternalPlugin::executeContextFunction ( const String & function_name )

pure virtual

Executes the function function_name with a context.

You must have loaded a script containing this function (via loadFile()) before calling this method. The specified method must take an instance of PythonSubDomainContext as an argument.

executeFunction()

virtual void Arcane::IExternalPlugin::executeFunction ( const String & function_name )

pure virtual

Executes the function function_name.

You must have loaded a script containing this function (via loadFile()) before calling this method. The method function_name must not have arguments.

loadFile()

virtual void Arcane::IExternalPlugin::loadFile ( const String & filename )

pure virtual

Loads and executes a file containing an external script.

filename may be null, in which case only the instance is initialized.

---

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

• IExternalPlugin.h