Arcane  v3.16.0.0
Documentation développeur
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::TraceAccessor
 TraceAccessor (ITraceMng *m)
 Construit un accesseur via le gestionnaire de trace m.
 
 TraceAccessor (const TraceAccessor &rhs)
 Constructeur par recopie.
 
TraceAccessoroperator= (const TraceAccessor &rhs)
 Opérateur de recopie.
 
virtual ~TraceAccessor ()
 Libère les ressources.
 
ITraceMngtraceMng () const
 Gestionnaire de trace.
 
TraceMessage info () const
 Flot pour un message d'information.
 
TraceMessage pinfo () const
 Flot pour un message d'information en parallèle.
 
TraceMessage info (char category) const
 Flot pour un message d'information d'une catégorie donnée.
 
TraceMessage pinfo (char category) const
 Flot pour un message d'information parallèle d'une catégorie donnée.
 
TraceMessage info (bool v) const
 Flot pour un message d'information.
 
TraceMessage warning () const
 Flot pour un message d'avertissement.
 
TraceMessage pwarning () const
 
TraceMessage error () const
 Flot pour un message d'erreur.
 
TraceMessage perror () const
 
TraceMessage log () const
 Flot pour un message de log.
 
TraceMessage plog () const
 Flot pour un message de log.
 
TraceMessage logdate () const
 Flot pour un message de log précédé de la date.
 
TraceMessage fatal () const
 Flot pour un message d'erreur fatale.
 
TraceMessage pfatal () const
 Flot pour un message d'erreur fatale en parallèle.
 
TraceMessageDbg debug (Trace::eDebugLevel=Trace::Medium) const
 Flot pour un message de debug.
 
Trace::eDebugLevel configDbgLevel () const
 Niveau debug du fichier de configuration.
 
TraceMessage info (Int32 verbose_level) const
 Flot pour un message d'information d'un niveau donné
 
TraceMessage linfo () const
 Flot pour un message d'information avec le niveau d'information local à cette instance.
 
TraceMessage linfo (Int32 relative_level) const
 Flot pour un message d'information avec le niveau d'information local à cette instance.
 
void fatalMessage (const StandaloneTraceMessage &o) const
 
- 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)
 
- Fonctions membres protégées hérités de Arcane::TraceAccessor
void _setLocalVerboseLevel (Int32 v)
 
Int32 _localVerboseLevel () const
 

Attributs privés

ISessionm_session
 Sesion.
 
ISubDomainm_sub_domain
 sous-domaine
 
MeshHandle m_default_mesh_handle
 Maillage par défaut du module.
 
String m_name
 Nom du module.
 
bool m_used
 true si le module est utilisé
 
bool m_disabled
 Etat d'activation du module.
 
VersionInfo m_version_info
 Version du module.
 
IAcceleratorMngm_accelerator_mng
 Gestionnaire des accélérateurs.
 

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.

Références acceleratorMng(), m_accelerator_mng, m_default_mesh_handle, m_disabled, m_name, m_session, m_sub_domain, m_used, m_version_info, name(), session(), subDomain(), Arcane::TraceAccessor::TraceAccessor(), et traceMng().

Référencé par Arcane::BasicModule::BasicModule(), et Arcane::ModuleMaster::ModuleMaster().

+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ ~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.

Références m_accelerator_mng.

Référencé par AbstractModule().

+ Voici le graphe des appelants de cette fonction :

◆ 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.

Références m_default_mesh_handle.

Référencé par Arcane::ArcanePostProcessingModule::_readConfig().

+ Voici le graphe des appelants de cette fonction :

◆ 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.

Références m_default_mesh_handle.

◆ 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.

Références m_disabled.

◆ 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.

A faire
Vérifier dans ModuleMng::removeModule l'utilisation de cette indication. Un appel au Deleter comme dans ModuleMng::removeAllModules est peut-être nécessaire.

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.

Références m_name.

Référencé par AbstractModule(), Arcane::TimeHistoryMng2::addValue(), Arcane::TimeHistoryMng2::addValue(), Arcane::TimeHistoryMng2::addValue(), Arcane::TimeHistoryMng2::addValue(), Arcane::TimeHistoryMng2::addValue(), Arcane::TimeHistoryMng2::addValue(), et Arcane::TimeHistoryMng2::removeCurveWriter().

+ Voici le graphe des appelants de cette fonction :

◆ 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 m_sub_domain.

Référencé par Arcane::TimeHistoryMng2::addValue(), Arcane::TimeHistoryMng2::addValue(), Arcane::TimeHistoryMng2::addValue(), Arcane::TimeHistoryMng2::addValue(), Arcane::TimeHistoryMng2::addValue(), Arcane::TimeHistoryMng2::addValue(), et Arcane::ModuleMaster::timeLoopBegin().

+ Voici le graphe des appelants de cette fonction :

◆ session()

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

Session associé au module.

Implémente Arcane::IModule.

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

Références m_session.

Référencé par AbstractModule().

+ Voici le graphe des appelants de cette fonction :

◆ 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.

Références m_disabled.

◆ 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.

Références m_used.

◆ 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()

◆ traceMng()

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

Gestionnaire de traces.

Implémente Arcane::IModule.

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

Références Arcane::TraceAccessor::traceMng().

Référencé par AbstractModule().

+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ 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.

Références m_used.

◆ versionInfo()

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

Documentation des données membres

◆ m_accelerator_mng

IAcceleratorMng* Arcane::AbstractModule::m_accelerator_mng
private

Gestionnaire des accélérateurs.

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

Référencé par AbstractModule(), et acceleratorMng().

◆ m_default_mesh_handle

MeshHandle Arcane::AbstractModule::m_default_mesh_handle
private

Maillage par défaut du module.

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

Référencé par AbstractModule(), defaultMesh(), et defaultMeshHandle().

◆ m_disabled

bool Arcane::AbstractModule::m_disabled
private

Etat d'activation du module.

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

Référencé par AbstractModule(), disabled(), et setDisabled().

◆ m_name

String Arcane::AbstractModule::m_name
private

Nom du module.

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

Référencé par AbstractModule(), et name().

◆ m_session

ISession* Arcane::AbstractModule::m_session
private

Sesion.

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

Référencé par AbstractModule(), et session().

◆ m_sub_domain

ISubDomain* Arcane::AbstractModule::m_sub_domain
private

sous-domaine

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

Référencé par AbstractModule(), parallelMng(), et subDomain().

◆ m_used

bool Arcane::AbstractModule::m_used
private

true si le module est utilisé

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

Référencé par AbstractModule(), setUsed(), et used().

◆ m_version_info

VersionInfo Arcane::AbstractModule::m_version_info
private

Version du module.

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

Référencé par AbstractModule(), et versionInfo().


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