Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
IExternalPlugin.h
1// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
2//-----------------------------------------------------------------------------
3// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
4// See the top-level COPYRIGHT file for details.
5// SPDX-License-Identifier: Apache-2.0
6//-----------------------------------------------------------------------------
7/*---------------------------------------------------------------------------*/
8/* IExternalPlugin.h (C) 2000-2025 */
9/* */
10/* Interface for external plugin service. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_CORE_IEXTERNALPLUGIN_H
13#define ARCANE_CORE_IEXTERNALPLUGIN_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
17#include "arcane/core/ArcaneTypes.h"
18
19/*---------------------------------------------------------------------------*/
20/*---------------------------------------------------------------------------*/
21// WARNING: Experimental API. Do not use outside of Arcane
22
23namespace Arcane
24{
25
26/*---------------------------------------------------------------------------*/
27/*---------------------------------------------------------------------------*/
28
36class ARCANE_CORE_EXPORT IExternalPlugin
37{
38 public:
39
41 virtual ~IExternalPlugin() = default;
42
43 public:
44
50 virtual void loadFile(const String& filename) = 0;
51
59 virtual void executeFunction(const String& function_name) = 0;
60
68 virtual void executeContextFunction(const String& function_name) = 0;
69};
70
71/*---------------------------------------------------------------------------*/
72/*---------------------------------------------------------------------------*/
73
74} // namespace Arcane
75
76/*---------------------------------------------------------------------------*/
77/*---------------------------------------------------------------------------*/
78
79#endif
ArcaneTypes.h
Declarations of Arcane's general types.
Arcane::IExternalPlugin
Interface for external service loading.
Definition IExternalPlugin.h:37
Arcane::IExternalPlugin::executeContextFunction
virtual void executeContextFunction(const String &function_name)=0
Executes the function function_name with a context.
Arcane::IExternalPlugin::loadFile
virtual void loadFile(const String &filename)=0
Loads and executes a file containing an external script.
Arcane::IExternalPlugin::executeFunction
virtual void executeFunction(const String &function_name)=0
Executes the function function_name.
Arcane::IExternalPlugin::~IExternalPlugin
virtual ~IExternalPlugin()=default
Releases resources.
Arcane
-- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature --
Definition arcane/src/arcane/accelerator/AcceleratorGlobal.h:37