Interface du gestionnaire de cas. Plus de détails...

#include <arcane/core/ICaseMng.h>

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

Graphe de collaboration de Arcane::ICaseMng:

Fonctions membres publiques
virtual	~ICaseMng ()=default
	Libère les ressources.

virtual IApplication *	application ()=0
	Application associée.

virtual ITraceMng *	traceMng ()=0
	Gestionnaire de traces.

virtual IMeshMng *	meshMng () const =0
	Gestionnaire de maillage associé

virtual ISubDomain *	subDomain ()=0
	Gestionnaire de sous-domaine.

virtual ICaseDocument *	caseDocument ()=0
	Document XML du jeu de données (peut être nul si pas de jeu de donneés)

virtual ICaseDocumentFragment *	caseDocumentFragment ()=0
	Fragment du Document XML associé au jeu de données (peut être nul si pas de jeu de donneés)

virtual IPhysicalUnitSystem *	physicalUnitSystem () const =0
	Système d'unité associé.

virtual ICaseDocument *	readCaseDocument (const String &filename, ByteConstArrayView bytes)=0
	Lit le document XML du jeu de données.

virtual void	readOptions (bool is_phase1)=0
	Lit les options du jeu de donnée correspondant aux modules utilisés.

virtual void	printOptions ()=0
	Affiche les valeurs des options.

virtual void	readFunctions ()=0
	Lit les tables du jeu de donnée.

virtual void	registerOptions (ICaseOptions *)=0
	Enregistre une liste d'options du jeu de donnée.

virtual void	unregisterOptions (ICaseOptions *)=0
	Déseregistre une liste d'options du jeu de donnée.

virtual CaseOptionsCollection	blocks () const =0
	Collection des blocs d'options.

virtual ICaseFunction *	findFunction (const String &name) const =0
	Retourne la fonction de nom name ou nullptr s'il n'y en a pas.

virtual CaseFunctionCollection	functions ()=0
	Retourne la liste des tables.

virtual void	removeFunction (ICaseFunction *func, bool dofree)=0
	Supprime une fonction.

virtual void	removeFunction (ICaseFunction *func)=0
	Supprime une fonction.

virtual void	addFunction (ICaseFunction *func)=0
	Ajoute la fonction func.

virtual void	addFunction (Ref< ICaseFunction > func)=0
	Ajoute la fonction func.

virtual void	updateOptions (Real current_time, Real current_deltat, Integer current_iteration)=0
	Met à jour les options basée sur une table de marche en temps.

virtual void	setTreatWarningAsError (bool v)=0
	Positionne la manière de traiter les avertissements.

virtual bool	isTreatWarningAsError () const =0
	Indique si les avertissements dans le jeu de données doivent être traités comme des erreurs et provoquer l'arrêt du code.

virtual void	setAllowUnkownRootElelement (bool v)=0
	Positionne l'autorisation des éléments inconnus à la racine du document.

virtual bool	isAllowUnkownRootElelement () const =0
	Indique si les éléments inconnus à la racine du document sont autorisés.

virtual IObservable *	observable (eCaseMngEventType type)=0
	Observable sur l'instance.

virtual Ref< ICaseMng >	toReference ()=0

virtual ICaseMngInternal *	_internalImpl ()=0
	Implémentation interne.

Fonctions membres privées
	ARCCORE_DECLARE_REFERENCE_COUNTED_INCLASS_METHODS ()

Description détaillée

Interface du gestionnaire de cas.

Cette interface est gérée par un compteur de référence et ne doit pas être détruite explictement.

Définition à la ligne 55 du fichier ICaseMng.h.

Documentation des fonctions membres

◆ _internalImpl()

virtual ICaseMngInternal * Arcane::ICaseMng::_internalImpl ( )

pure virtual

Implémentation interne.

Implémenté dans Arcane::CaseMng.

◆ addFunction() [1/2]

virtual void Arcane::ICaseMng::addFunction ( ICaseFunction * func )

pure virtual

Ajoute la fonction func.

L'ajout ne peut se faire que lors de l'initialisation. L'appelant reste propriétaire de l'instance func et doit l'enlever via removeFunction().

Implémenté dans Arcane::CaseMng.

◆ addFunction() [2/2]

virtual void Arcane::ICaseMng::addFunction ( Ref< ICaseFunction > func )

pure virtual

Ajoute la fonction func.

L'ajout ne peut se faire que lors de l'initialisation.

Implémenté dans Arcane::CaseMng.

◆ application()

virtual IApplication * Arcane::ICaseMng::application ( )

pure virtual

Application associée.

Implémenté dans Arcane::CaseMng.

◆ blocks()

virtual CaseOptionsCollection Arcane::ICaseMng::blocks ( ) const

pure virtual

Collection des blocs d'options.

Implémenté dans Arcane::CaseMng.

◆ caseDocument()

virtual ICaseDocument * Arcane::ICaseMng::caseDocument ( )

pure virtual

Document XML du jeu de données (peut être nul si pas de jeu de donneés)

Implémenté dans Arcane::CaseMng.

Référencé par Arcane::SubDomain::allocateMeshes().

◆ caseDocumentFragment()

virtual ICaseDocumentFragment * Arcane::ICaseMng::caseDocumentFragment ( )

pure virtual

Fragment du Document XML associé au jeu de données (peut être nul si pas de jeu de donneés)

Implémenté dans Arcane::CaseMng.

◆ findFunction()

virtual ICaseFunction * Arcane::ICaseMng::findFunction ( const String & name ) const

pure virtual

Retourne la fonction de nom name ou nullptr s'il n'y en a pas.

Implémenté dans Arcane::CaseMng.

Référencé par Arcane::CaseOptions::read().

◆ functions()

virtual CaseFunctionCollection Arcane::ICaseMng::functions ( )

pure virtual

Retourne la liste des tables.

Le pointeur retourné n'est plus valide dès que la liste des tables change.

Implémenté dans Arcane::CaseMng.

◆ isAllowUnkownRootElelement()

virtual bool Arcane::ICaseMng::isAllowUnkownRootElelement ( ) const

pure virtual

Indique si les éléments inconnus à la racine du document sont autorisés.

Implémenté dans Arcane::CaseMng.

◆ isTreatWarningAsError()

virtual bool Arcane::ICaseMng::isTreatWarningAsError ( ) const

pure virtual

Indique si les avertissements dans le jeu de données doivent être traités comme des erreurs et provoquer l'arrêt du code.

Implémenté dans Arcane::CaseMng.

◆ meshMng()

virtual IMeshMng * Arcane::ICaseMng::meshMng ( ) const

pure virtual

Gestionnaire de maillage associé

Implémenté dans Arcane::CaseMng.

Référencé par Arcane::CaseOptions::_setMeshHandleAndCheckDisabled().

◆ observable()

virtual IObservable * Arcane::ICaseMng::observable ( eCaseMngEventType type )

pure virtual

Observable sur l'instance.

Le type de l'observable est donné par type

Implémenté dans Arcane::CaseMng.

◆ physicalUnitSystem()

virtual IPhysicalUnitSystem * Arcane::ICaseMng::physicalUnitSystem ( ) const

pure virtual

Système d'unité associé.

Implémenté dans Arcane::CaseMng.

◆ printOptions()

virtual void Arcane::ICaseMng::printOptions ( )

pure virtual

Affiche les valeurs des options.

Implémenté dans Arcane::CaseMng.

◆ readCaseDocument()

virtual ICaseDocument * Arcane::ICaseMng::readCaseDocument	(	const String &	filename,
		ByteConstArrayView	bytes
	)

pure virtual

Lit le document XML du jeu de données.

Implémenté dans Arcane::CaseMng.

◆ readFunctions()

virtual void Arcane::ICaseMng::readFunctions ( )

pure virtual

Lit les tables du jeu de donnée.

Implémenté dans Arcane::CaseMng.

◆ readOptions()

virtual void Arcane::ICaseMng::readOptions ( bool is_phase1 )

pure virtual

Lit les options du jeu de donnée correspondant aux modules utilisés.

Implémenté dans Arcane::CaseMng.

◆ registerOptions()

virtual void Arcane::ICaseMng::registerOptions ( ICaseOptions * )

pure virtual

Enregistre une liste d'options du jeu de donnée.

Implémenté dans Arcane::CaseMng.

◆ removeFunction() [1/2]

virtual void Arcane::ICaseMng::removeFunction ( ICaseFunction * func )

pure virtual

Supprime une fonction.

Supprime la fonction func. Si cette fonction n'est pas dans cette liste, ne fait rien.

Implémenté dans Arcane::CaseMng.

◆ removeFunction() [2/2]

virtual void Arcane::ICaseMng::removeFunction	(	ICaseFunction *	func,
		bool	dofree
	)

pure virtual

Supprime une fonction.

Supprime la fonction func. Si cette fonction n'est pas dans cette liste, ne fait rien. Si dofree est vrai, l'opérateur delete est appelé sur cette fonction.

Implémenté dans Arcane::CaseMng.

◆ setAllowUnkownRootElelement()

virtual void Arcane::ICaseMng::setAllowUnkownRootElelement ( bool v )

pure virtual

Positionne l'autorisation des éléments inconnus à la racine du document.

Implémenté dans Arcane::CaseMng.

◆ setTreatWarningAsError()

virtual void Arcane::ICaseMng::setTreatWarningAsError ( bool v )

pure virtual

Positionne la manière de traiter les avertissements.

Voir également: isTreatWarningAsError().

Implémenté dans Arcane::CaseMng.

◆ subDomain()

virtual ISubDomain * Arcane::ICaseMng::subDomain ( )

pure virtual

Gestionnaire de sous-domaine.

Implémenté dans Arcane::CaseMng.

Référencé par Arcane::CaseOptionBase::subDomain(), et Arcane::CaseOptions::subDomain().

◆ traceMng()

virtual ITraceMng * Arcane::ICaseMng::traceMng ( )

pure virtual

Gestionnaire de traces.

Implémenté dans Arcane::CaseMng.

Référencé par Arcane::CaseOptionBase::traceMng().

◆ unregisterOptions()

virtual void Arcane::ICaseMng::unregisterOptions ( ICaseOptions * )

pure virtual

Déseregistre une liste d'options du jeu de donnée.

Implémenté dans Arcane::CaseMng.

Référencé par Arcane::CaseOptions::~CaseOptions().

◆ updateOptions()

virtual void Arcane::ICaseMng::updateOptions	(	Real	current_time,
		Real	current_deltat,
		Integer	current_iteration
	)

pure virtual

Met à jour les options basée sur une table de marche en temps.

Pour chaque option dépendant d'une table de marche, met à jour sa valeur en utilisant le paramètre current_time s'il s'agit d'une table de marche avec paramètre réel ou current_iteration s'il s'agit d'une table de marche avec paramètre entier. Si la fonction de l'option possède un coefficient ICaseFunction::deltatCoef() non nul, le temps utilisé est égal à current_time + coef*current_deltat.

Paramètres

current_time	temps utilisé comme paramètre pour la fonction
current_deltat	deltat utilisé comme paramètre pour la fonction
current_iteration	itération utilisé comme paramètre pour la fonction

Implémenté dans Arcane::CaseMng.

La documentation de cette classe a été générée à partir du fichier suivant :

ICaseMng.h

Fonctions membres publiques

Fonctions membres privées

Description détaillée

Documentation des fonctions membres

◆ _internalImpl()

◆ addFunction() [1/2]

◆ addFunction() [2/2]

◆ application()

◆ blocks()

◆ caseDocument()

◆ caseDocumentFragment()

◆ findFunction()

◆ functions()

◆ isAllowUnkownRootElelement()

◆ isTreatWarningAsError()

◆ meshMng()

◆ observable()

◆ physicalUnitSystem()

◆ printOptions()

◆ readCaseDocument()

◆ readFunctions()

◆ readOptions()

◆ registerOptions()

◆ removeFunction() [1/2]

◆ removeFunction() [2/2]

◆ setAllowUnkownRootElelement()

◆ setTreatWarningAsError()

◆ subDomain()

◆ traceMng()

◆ unregisterOptions()

◆ updateOptions()