Interface d'un point d'entrée d'un module. Plus de détails...

#include <arcane/core/IEntryPoint.h>

Graphe d'héritage de Arcane::IEntryPoint:

Graphe de collaboration de Arcane::IEntryPoint:

Point d'appel
Endroit ou est utilisé le point d'entrée.
enum	{ PNone = 0 , PAutoLoadBegin = 1 , PAutoLoadEnd = 2 }
	Propriétés d'un point d'entrée. Plus de détails...

static const char *const	WComputeLoop = "ComputeLoop"
	appelé pendant la boucle de calcul

static const char *const	WBuild = "Build"
	appelé pour la construction du module

static const char *const	WInit = "Init"
	appelé pendant l'initialisation

static const char *const	WContinueInit = "ContinueInit"
	appelé pendant l'initialisation d'une reprise

static const char *const	WStartInit = "StartInit"
	appelé pendant l'initialisation d'un nouveau cas

static const char *const	WRestore = "Restore"
	appelé pour restaurer les variables lors d'un retour arrière

static const char *const	WOnMeshChanged = "OnMeshChanged"
	appelé après un changement de maillage

static const char *const	WOnMeshRefinement = "OnMeshRefinement"
	appelé après un raffinement de maillage

static const char *const	WExit = "Exit"

virtual	~IEntryPoint ()=default
	Libère les ressources.

virtual String	name () const =0
	Retourne le nom du point d'entrée.

virtual String	fullName () const =0
	Nom complet (avec le module) du point d'entrée. Ce nom est unique.

virtual ISubDomain *	subDomain () const =0
	Retourne le gestionnaire principal.

virtual IModule *	module () const =0
	Retourne le module associé au point d'entrée.

virtual void	executeEntryPoint ()=0
	Appelle le point d'entrée.

virtual Real	totalCPUTime () const =0
	Consommation CPU totale passé dans ce point d'entrée en (en milli-s).

virtual Real	lastCPUTime () const =0
	Consommation CPU de la dernière itération (en milli-s).

virtual Real	totalElapsedTime () const =0
	Temps d'exécution passé (temps horloge) dans ce point d'entrée en (en milli-s)

virtual Real	lastElapsedTime () const =0
	Temps d'exécution (temps horloge) de la dernière itération (en milli-s).

virtual Real	totalTime (Timer::eTimerType) const =0
	Retourne totalElapsedTime().

virtual Real	lastTime (Timer::eTimerType) const =0
	Retourne lastElapsedTime().

virtual Integer	nbCall () const =0
	Retourne le nombre de fois que le point d'entrée a été exécuté

virtual String	where () const =0
	Retourne l'endroit ou est appelé le point d'entrée.

virtual int	property () const =0
	Retourne les propriétés du point d'entrée.

Description détaillée

Interface d'un point d'entrée d'un module.

Définition à la ligne 33 du fichier IEntryPoint.h.

Documentation des énumérations membres

◆ anonymous enum

anonymous enum

Propriétés d'un point d'entrée.

Valeurs énumérées
PNone	Pas de propriétés.
PAutoLoadBegin	Chargé automatiquement au début. Cela signifie qu'un module possédant un point d'entrée avec cette propriété sera toujours chargé, et que le point d'entrée sera ajouté à la liste des points d'entrées s'exécutant en début de boucle en temps.
PAutoLoadEnd	Chargé automatiquement à la fin. Cela signifie qu'un module possédant un point d'entrée avec cette propriété sera toujours chargé, et que le point d'entrée sera ajouté à la liste des points d'entrées s'exécutant en fin de boucle en temps.

Définition à la ligne 64 du fichier IEntryPoint.h.

Documentation des fonctions membres

◆ executeEntryPoint()

virtual void Arcane::IEntryPoint::executeEntryPoint ( )

pure virtual

Appelle le point d'entrée.

Implémenté dans Arcane::EntryPoint.

◆ fullName()

virtual String Arcane::IEntryPoint::fullName ( ) const

pure virtual

Nom complet (avec le module) du point d'entrée. Ce nom est unique.

Implémenté dans Arcane::EntryPoint.

◆ lastCPUTime()

virtual Real Arcane::IEntryPoint::lastCPUTime ( ) const

pure virtual

Consommation CPU de la dernière itération (en milli-s).

Note: depuis la version 3.6 de Arcane, cette méthode renvoie la même valeur que lastElapsedTime().

Implémenté dans Arcane::EntryPoint.

◆ lastElapsedTime()

virtual Real Arcane::IEntryPoint::lastElapsedTime ( ) const

pure virtual

Temps d'exécution (temps horloge) de la dernière itération (en milli-s).

Implémenté dans Arcane::EntryPoint.

◆ lastTime()

virtual Real Arcane::IEntryPoint::lastTime ( Timer::eTimerType ) const

pure virtual

Retourne lastElapsedTime().

Obsolète:: Utiliser lastElapsedTime() à la place

Implémenté dans Arcane::EntryPoint.

◆ module()

virtual IModule * Arcane::IEntryPoint::module ( ) const

pure virtual

Retourne le module associé au point d'entrée.

Implémenté dans Arcane::EntryPoint.

Référencé par Arcane::EntryPointMng::addEntryPoint().

◆ name()

virtual String Arcane::IEntryPoint::name ( ) const

pure virtual

Retourne le nom du point d'entrée.

Implémenté dans Arcane::EntryPoint.

Référencé par Arcane::EntryPointMng::addEntryPoint().

◆ nbCall()

virtual Integer Arcane::IEntryPoint::nbCall ( ) const

pure virtual

Retourne le nombre de fois que le point d'entrée a été exécuté

Implémenté dans Arcane::EntryPoint.

◆ property()

virtual int Arcane::IEntryPoint::property ( ) const

pure virtual

Retourne les propriétés du point d'entrée.

Implémenté dans Arcane::EntryPoint.

◆ subDomain()

virtual ISubDomain * Arcane::IEntryPoint::subDomain ( ) const

pure virtual

Retourne le gestionnaire principal.

Implémenté dans Arcane::EntryPoint.

◆ totalCPUTime()

virtual Real Arcane::IEntryPoint::totalCPUTime ( ) const

pure virtual

Consommation CPU totale passé dans ce point d'entrée en (en milli-s).

Note: depuis la version 3.6 de Arcane, cette méthode renvoie la même valeur que totalElapsedTime().

Implémenté dans Arcane::EntryPoint.

◆ totalElapsedTime()

virtual Real Arcane::IEntryPoint::totalElapsedTime ( ) const

pure virtual

Temps d'exécution passé (temps horloge) dans ce point d'entrée en (en milli-s)

Implémenté dans Arcane::EntryPoint.

◆ totalTime()

virtual Real Arcane::IEntryPoint::totalTime ( Timer::eTimerType ) const

pure virtual

Retourne totalElapsedTime().

Obsolète:: Utiliser totalElapsedTime() à la place

Implémenté dans Arcane::EntryPoint.

◆ where()

virtual String Arcane::IEntryPoint::where ( ) const

pure virtual

Retourne l'endroit ou est appelé le point d'entrée.

Implémenté dans Arcane::EntryPoint.

Documentation des données membres

◆ WBuild

const char *const Arcane::IEntryPoint::WBuild = "Build"

static

appelé pour la construction du module

Définition à la ligne 44 du fichier IEntryPoint.h.

Référencé par Arcane::TimeLoopMng::_addExecuteEntryPoint(), et Arcane::TimeLoopMng::execBuildEntryPoints().

◆ WComputeLoop

const char *const Arcane::IEntryPoint::WComputeLoop = "ComputeLoop"

static

appelé pendant la boucle de calcul

Définition à la ligne 42 du fichier IEntryPoint.h.

Référencé par Arcane::TimeLoopMng::_addExecuteEntryPoint(), Arcane::TimeLoopMng::_processEntryPoints(), et Arcane::ModuleMaster::ModuleMaster().

◆ WContinueInit

const char *const Arcane::IEntryPoint::WContinueInit = "ContinueInit"

static

appelé pendant l'initialisation d'une reprise

Définition à la ligne 48 du fichier IEntryPoint.h.

Référencé par Arcane::TimeLoopMng::_addExecuteEntryPoint(), Arcane::TimeLoopMng::_processEntryPoints(), Arcane::TimeLoopMng::execInitEntryPoints(), et Arcane::ModuleMaster::ModuleMaster().

◆ WExit

const char *const Arcane::IEntryPoint::WExit = "Exit"

static

Définition à la ligne 58 du fichier IEntryPoint.h.

◆ WInit

const char *const Arcane::IEntryPoint::WInit = "Init"

static

appelé pendant l'initialisation

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

Référencé par Arcane::TimeLoopMng::_addExecuteEntryPoint(), Arcane::TimeLoopMng::_processEntryPoints(), Arcane::TimeLoopMng::execInitEntryPoints(), et Arcane::ModuleMaster::ModuleMaster().

◆ WOnMeshChanged

const char *const Arcane::IEntryPoint::WOnMeshChanged = "OnMeshChanged"

static

appelé après un changement de maillage

Définition à la ligne 54 du fichier IEntryPoint.h.

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

◆ WOnMeshRefinement

const char *const Arcane::IEntryPoint::WOnMeshRefinement = "OnMeshRefinement"

static

appelé après un raffinement de maillage

appelé lors de la terminaison du code.

Définition à la ligne 56 du fichier IEntryPoint.h.

Référencé par Arcane::TimeLoopMng::_addExecuteEntryPoint().

◆ WRestore

const char *const Arcane::IEntryPoint::WRestore = "Restore"

static

appelé pour restaurer les variables lors d'un retour arrière

Définition à la ligne 52 du fichier IEntryPoint.h.

Référencé par Arcane::TimeLoopMng::_addExecuteEntryPoint(), Arcane::TimeLoopMng::_processEntryPoints(), et Arcane::ModuleMaster::ModuleMaster().

◆ WStartInit

const char *const Arcane::IEntryPoint::WStartInit = "StartInit"

static

appelé pendant l'initialisation d'un nouveau cas

Définition à la ligne 50 du fichier IEntryPoint.h.

Référencé par Arcane::TimeLoopMng::_addExecuteEntryPoint(), Arcane::TimeLoopMng::_processEntryPoints(), Arcane::TimeLoopMng::execInitEntryPoints(), et Arcane::ModuleMaster::ModuleMaster().

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

Point d'appel

Description détaillée

Documentation des énumérations membres

◆ anonymous enum

Documentation des fonctions membres

◆ executeEntryPoint()

◆ fullName()

◆ lastCPUTime()

◆ lastElapsedTime()

◆ lastTime()

◆ module()

◆ name()

◆ nbCall()

◆ property()

◆ subDomain()

◆ totalCPUTime()

◆ totalElapsedTime()

◆ totalTime()

◆ where()

Documentation des données membres

◆ WBuild

◆ WComputeLoop

◆ WContinueInit

◆ WExit

◆ WInit

◆ WOnMeshChanged

◆ WOnMeshRefinement

◆ WRestore

◆ WStartInit