Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
IEntryPointMng.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/* IEntryPointMng.h (C) 2000-2023 */
9/* */
10/* Interface for the entry point manager. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_CORE_IENTRYPOINTMNG_H
13#define ARCANE_CORE_IENTRYPOINTMNG_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
18
19/*---------------------------------------------------------------------------*/
20/*---------------------------------------------------------------------------*/
21
22namespace Arcane
23{
24
25/*---------------------------------------------------------------------------*/
26/*---------------------------------------------------------------------------*/
27
28/*!
29 * \internal
30 * \brief Interface for the entry point manager.
31 */
33{
34 public:
35
36 virtual ~IEntryPointMng() = default; //!< Frees resources.
37
38 public:
39
40 //! Adds an entry point to the manager
41 virtual void addEntryPoint(IEntryPoint*) = 0;
42
43 /*!
44 * \brief Entry point by name \a s.
45 *
46 * Returns \a nullptr if the entry point is not found
47 */
48 virtual IEntryPoint* findEntryPoint(const String& s) = 0;
49
50 /*!
51 * \brief Entry point by name \a s from module name \a module_name.
52 *
53 * Returns \a nullptr if the entry point is not found
54 */
55 virtual IEntryPoint* findEntryPoint(const String& module_name, const String& s) = 0;
56
57 //! Displays the list of entry points of the manager in \o
58 virtual void dumpList(std::ostream& o) = 0;
59
60 //! List of entry points
62};
63
64/*---------------------------------------------------------------------------*/
65/*---------------------------------------------------------------------------*/
66
67} // namespace Arcane
68
69/*---------------------------------------------------------------------------*/
70/*---------------------------------------------------------------------------*/
71
72#endif
Declarations of Arcane's general types.
virtual IEntryPoint * findEntryPoint(const String &s)=0
Entry point by name s.
virtual void addEntryPoint(IEntryPoint *)=0
Adds an entry point to the manager.
virtual EntryPointCollection entryPoints()=0
List of entry points.
virtual void dumpList(std::ostream &o)=0
Displays the list of entry points of the manager in \o.
virtual ~IEntryPointMng()=default
Frees resources.
virtual IEntryPoint * findEntryPoint(const String &module_name, const String &s)=0
Entry point by name s from module name module_name.
Interface of a module entry point.
Definition IEntryPoint.h:35
-- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature --
Collection< IEntryPoint * > EntryPointCollection
Collection of entry points.