Arcane  v3.15.3.0
Documentation utilisateur
Chargement...
Recherche...
Aucune correspondance
Référence de la classe Arcane::AbstractModule

Classe représentant un module. Plus de détails...

#include <arcane/core/AbstractModule.h>

+ Graphe d'héritage de Arcane::AbstractModule:
+ Graphe de collaboration de Arcane::AbstractModule:

Fonctions membres publiques

 AbstractModule (const ModuleBuildInfo &)
 Constructeur à partir d'un ModuleBuildInfo.
 
virtual ~AbstractModule ()
 Destructeur.
 
VersionInfo versionInfo () const override
 Version du module.
 
String name () const override
 Nom du module.
 
ISessionsession () const override
 Session associé au module.
 
ISubDomainsubDomain () const override
 Sous-domaine associé au module.
 
IMeshdefaultMesh () const override
 Maillage par défaut pour ce module.
 
MeshHandle defaultMeshHandle () const override
 Maillage par défaut pour ce module.
 
IParallelMngparallelMng () const override
 Gestionnaire du parallélisme par échange de message.
 
IAcceleratorMngacceleratorMng () const override
 Gestionnaire des accélérateurs.
 
ITraceMngtraceMng () const override
 Gestionnaire de traces.
 
void setUsed (bool v) override
 Positionne le flag d'utilisation du module.
 
bool used () const override
 Retourne l'état d'utilisation du module.
 
void setDisabled (bool v) override
 Positionne le flag d'activation du module.
 
bool disabled () const override
 Retourne l'état d'activation du module.
 
bool isGarbageCollected () const override
 Indique si le module utilise un système de Garbage collection.
 
- Fonctions membres publiques hérités de Arcane::IModule
virtual ~IModule ()
 Destructeur.
 

Fonctions membres publiques statiques

static void staticInitialize (ISubDomain *sd)
 Initialisation du module pour le sous-domaine sd.
 

Fonctions membres protégées

void _setVersionInfo (const VersionInfo &vi)
 

Description détaillée

Classe représentant un module.

Cette classe est LA classe d'implémentation bas niveau de l'interface IModule.

Définition à la ligne 46 du fichier AbstractModule.h.

Documentation des constructeurs et destructeur

◆ AbstractModule()

Arcane::AbstractModule::AbstractModule ( const ModuleBuildInfo mbi)

Constructeur à partir d'un ModuleBuildInfo.

Définition à la ligne 29 du fichier AbstractModule.cc.

◆ ~AbstractModule()

Arcane::AbstractModule::~AbstractModule ( )
virtual

Destructeur.

Définition à la ligne 46 du fichier AbstractModule.cc.

Documentation des fonctions membres

◆ _setVersionInfo()

void Arcane::AbstractModule::_setVersionInfo ( const VersionInfo vi)
inlineprotected

Définition à la ligne 126 du fichier AbstractModule.h.

◆ acceleratorMng()

IAcceleratorMng * Arcane::AbstractModule::acceleratorMng ( ) const
overridevirtual

Gestionnaire des accélérateurs.

Implémente Arcane::IModule.

Définition à la ligne 63 du fichier AbstractModule.cc.

◆ defaultMesh()

IMesh * Arcane::AbstractModule::defaultMesh ( ) const
inlineoverridevirtual

Maillage par défaut pour ce module.

Implémente Arcane::IModule.

Définition à la ligne 90 du fichier AbstractModule.h.

◆ defaultMeshHandle()

MeshHandle Arcane::AbstractModule::defaultMeshHandle ( ) const
inlineoverridevirtual

Maillage par défaut pour ce module.

Implémente Arcane::IModule.

Définition à la ligne 92 du fichier AbstractModule.h.

◆ disabled()

bool Arcane::AbstractModule::disabled ( ) const
inlineoverridevirtual

Retourne l'état d'activation du module.

Implémente Arcane::IModule.

Définition à la ligne 106 du fichier AbstractModule.h.

◆ isGarbageCollected()

bool Arcane::AbstractModule::isGarbageCollected ( ) const
inlineoverridevirtual

Indique si le module utilise un système de Garbage collection.

  • si true, indique une destruction par un Garbage collecteur et non une destruction explicite
  • si false, ce module sera détruit explicitement par un appel à son destructeur

Le système de Garbage collection est usuellement activé pour les modules issus d'une implémentation en C#. Les modules classiques en C++ n'ont pas se mécanisme.

Implémente Arcane::IModule.

Définition à la ligne 122 du fichier AbstractModule.h.

◆ name()

String Arcane::AbstractModule::name ( ) const
inlineoverridevirtual

Nom du module.

Implémente Arcane::IModule.

Définition à la ligne 84 du fichier AbstractModule.h.

◆ parallelMng()

IParallelMng * Arcane::AbstractModule::parallelMng ( ) const
overridevirtual

Gestionnaire du parallélisme par échange de message.

Implémente Arcane::IModule.

Définition à la ligne 54 du fichier AbstractModule.cc.

Références Arcane::ISubDomain::parallelMng().

Référencé par Arcane::ModuleMaster::timeLoopBegin().

◆ session()

ISession * Arcane::AbstractModule::session ( ) const
inlineoverridevirtual

Session associé au module.

Implémente Arcane::IModule.

Définition à la ligne 86 du fichier AbstractModule.h.

◆ setDisabled()

void Arcane::AbstractModule::setDisabled ( bool  v)
inlineoverridevirtual

Positionne le flag d'activation du module.

Implémente Arcane::IModule.

Définition à la ligne 104 du fichier AbstractModule.h.

◆ setUsed()

void Arcane::AbstractModule::setUsed ( bool  v)
inlineoverridevirtual

Positionne le flag d'utilisation du module.

Implémente Arcane::IModule.

Définition à la ligne 100 du fichier AbstractModule.h.

◆ staticInitialize()

static void Arcane::AbstractModule::staticInitialize ( ISubDomain sd)
inlinestatic

Initialisation du module pour le sous-domaine sd.

Cette méthode statique peut être redéfinie dans une classe dérivée pour effectuer des initialisations pour le sous-domaine sd même si le module n'est pas utilisé.

Une utilisation classique est l'enregistrement de points d'entrée pour des modules sans .axl

Cette méthode sera appelé pendant la phase de création du sous-domaine sur tous les Modules (même non utilisés).

Définition à la ligne 79 du fichier AbstractModule.h.

◆ subDomain()

ISubDomain * Arcane::AbstractModule::subDomain ( ) const
inlineoverridevirtual

◆ traceMng()

ITraceMng * Arcane::AbstractModule::traceMng ( ) const
overridevirtual

Gestionnaire de traces.

Implémente Arcane::IModule.

Définition à la ligne 72 du fichier AbstractModule.cc.

◆ used()

bool Arcane::AbstractModule::used ( ) const
inlineoverridevirtual

Retourne l'état d'utilisation du module.

Implémente Arcane::IModule.

Définition à la ligne 102 du fichier AbstractModule.h.

◆ versionInfo()

VersionInfo Arcane::AbstractModule::versionInfo ( ) const
inlineoverridevirtual

Version du module.

Implémente Arcane::IModule.

Réimplémentée dans Arcane::ModuleMaster.

Définition à la ligne 63 du fichier AbstractModule.h.


La documentation de cette classe a été générée à partir des fichiers suivants :