Arcane  v3.16.0.0
Documentation utilisateur
Chargement...
Recherche...
Aucune correspondance
Fonctions membres publiques | Fonctions membres protégées | Liste de tous les membres
Référence de la classe Arcane::CaseOptionBaseabstract
CaseOption

Classe de base d'une option du jeu de donnée. Plus de détails...

#include <arcane/core/CaseOptionBase.h>

Fonctions membres publiques

String trueName () const
 Retourne le vrai nom (non traduit) de l'option.
 
String name () const
 Retourne le nom de l'option correspondant au langage du jeu de données.
 
String translatedName (const String &lang) const
 Nom dans la langue lang de l'option. Retourne name() si pas de traduction.
 
void search (bool is_phase1)
 Récupère la valeur du fichier de configuration pour la variable.
 
virtual void print (const String &lang, std::ostream &o) const =0
 Imprime la valeur de l'option dans le langage lang,sur le flot o.
 
ICaseMng * caseMng () const
 Gestionnaire de cas.
 
ICaseOptionList * parentOptionList () const
 OptionList parent.
 
ITraceMng * traceMng () const
 Gestionnaire de traces.
 
ISubDomain * subDomain () const
 Gestionnaire de sous-domaine.
 
ICaseDocument * caseDocument () const
 Retourne le gestionnaire de document.
 
ICaseDocumentFragment * caseDocumentFragment () const
 Retourne le document associé à cette option.
 
void setRootElement (const XmlNode &root_element)
 Positionne l'élément racine à root_element.
 
XmlNode rootElement () const
 Retourne l'élément racine du DOM.
 
virtual ICaseFunction * function () const =0
 Retourne la fonction liée à cette option ou nullptr s'il n'y en a pas.
 
Integer minOccurs () const
 Nombre minimum d'occurences (pour une option multiple)
 
Integer maxOccurs () const
 Nombre maximum d'occurences (pour une option multiple) (-1 == unbounded)
 
bool isOptional () const
 Permet de savoir si une option est optionnelle.
 
virtual void updateFromFunction (Real current_time, Integer current_iteration)=0
 Met à jour la valeur de l'option à partir d'une fonction.
 
void addAlternativeNodeName (const String &lang, const String &name)
 Ajoute une traduction pour le nom de l'option.
 
void addDefaultValue (const String &category, const String &value)
 Ajoute la valeur par défaut value à la catégorie category.
 
virtual void visit (ICaseDocumentVisitor *visitor) const =0
 Applique le visiteur sur cette option.
 
void checkIsInitialized () const
 Lève une exception si l'option n'a pas été initialisée.
 

Fonctions membres protégées

 CaseOptionBase (const CaseOptionBuildInfo &cob)
 
String _defaultValue () const
 Retourne la valeur par défaut de l'option ou 0 s'il n'y en a pas.
 
void _setDefaultValue (const String &def_value)
 
virtual void _search (bool is_phase1)=0
 
void _setIsInitialized ()
 
bool _isInitialized () const
 
void _checkIsInitialized () const
 
void _checkMinMaxOccurs (Integer nb_occur)
 
String _xpathFullName () const
 

Description détaillée

Classe de base d'une option du jeu de donnée.

Fait le lien entre l'option de nom m_name et le noeud du DOM correspondant.

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

Documentation des constructeurs et destructeur

◆ CaseOptionBase()

Arcane::CaseOptionBase::CaseOptionBase ( const CaseOptionBuildInfo & cob)
protected

Définition à la ligne 93 du fichier CaseOptionBase.cc.

◆ ~CaseOptionBase()

Arcane::CaseOptionBase::~CaseOptionBase ( )
virtual

Définition à la ligne 103 du fichier CaseOptionBase.cc.

Documentation des fonctions membres

◆ _checkIsInitialized()

void Arcane::CaseOptionBase::_checkIsInitialized ( ) const
protected

Définition à la ligne 347 du fichier CaseOptionBase.cc.

◆ _checkMinMaxOccurs()

void Arcane::CaseOptionBase::_checkMinMaxOccurs ( Integer nb_occur)
protected

Définition à la ligne 358 du fichier CaseOptionBase.cc.

◆ _defaultValue()

String Arcane::CaseOptionBase::_defaultValue ( ) const
protected

Retourne la valeur par défaut de l'option ou 0 s'il n'y en a pas.

Définition à la ligne 166 du fichier CaseOptionBase.cc.

Référencé par Arcane::CaseOptionExtended::_search(), Arcane::CaseOptionMultiExtended::_search(), Arcane::CaseOptionMultiSimpleT< T >::_search(), et Arcane::CaseOptionSimpleT< T >::_search().

◆ _isInitialized()

bool Arcane::CaseOptionBase::_isInitialized ( ) const
protected

Définition à la ligne 338 du fichier CaseOptionBase.cc.

◆ _search()

virtual void Arcane::CaseOptionBase::_search ( bool is_phase1)
protectedpure virtual

Implémenté dans Arcane::CaseOptionExtended, Arcane::CaseOptionMultiExtended, Arcane::CaseOptionMultiSimpleT< T >, Arcane::CaseOptionSimpleT< T >, Arcane::CaseOptionSimpleT< bool >, Arcane::CaseOptionSimpleT< bool >, Arcane::CaseOptionSimpleT< BoolArray >, Arcane::CaseOptionSimpleT< BoolArray >, Arcane::CaseOptionSimpleT< Int32 >, Arcane::CaseOptionSimpleT< Int32 >, Arcane::CaseOptionSimpleT< Int32Array >, Arcane::CaseOptionSimpleT< Int32Array >, Arcane::CaseOptionSimpleT< Int64 >, Arcane::CaseOptionSimpleT< Int64 >, Arcane::CaseOptionSimpleT< Int64Array >, Arcane::CaseOptionSimpleT< Int64Array >, Arcane::CaseOptionSimpleT< Integer >, Arcane::CaseOptionSimpleT< Integer >, Arcane::CaseOptionSimpleT< IntegerArray >, Arcane::CaseOptionSimpleT< IntegerArray >, Arcane::CaseOptionSimpleT< Real >, Arcane::CaseOptionSimpleT< Real >, Arcane::CaseOptionSimpleT< Real2 >, Arcane::CaseOptionSimpleT< Real2 >, Arcane::CaseOptionSimpleT< Real2Array >, Arcane::CaseOptionSimpleT< Real2Array >, Arcane::CaseOptionSimpleT< Real2x2 >, Arcane::CaseOptionSimpleT< Real2x2 >, Arcane::CaseOptionSimpleT< Real2x2Array >, Arcane::CaseOptionSimpleT< Real2x2Array >, Arcane::CaseOptionSimpleT< Real3 >, Arcane::CaseOptionSimpleT< Real3 >, Arcane::CaseOptionSimpleT< Real3Array >, Arcane::CaseOptionSimpleT< Real3Array >, Arcane::CaseOptionSimpleT< Real3x3 >, Arcane::CaseOptionSimpleT< Real3x3 >, Arcane::CaseOptionSimpleT< Real3x3Array >, Arcane::CaseOptionSimpleT< Real3x3Array >, Arcane::CaseOptionSimpleT< RealArray >, Arcane::CaseOptionSimpleT< RealArray >, Arcane::CaseOptionSimpleT< String >, Arcane::CaseOptionSimpleT< String >, Arcane::CaseOptionSimpleT< StringArray >, et Arcane::CaseOptionSimpleT< StringArray >.

◆ _setDefaultValue()

void Arcane::CaseOptionBase::_setDefaultValue ( const String & def_value)
protected

Définition à la ligne 175 du fichier CaseOptionBase.cc.

◆ _setIsInitialized()

void Arcane::CaseOptionBase::_setIsInitialized ( )
protected

Définition à la ligne 329 du fichier CaseOptionBase.cc.

◆ _xpathFullName()

String Arcane::CaseOptionBase::_xpathFullName ( ) const
protected

Définition à la ligne 399 du fichier CaseOptionBase.cc.

◆ addAlternativeNodeName()

void Arcane::CaseOptionBase::addAlternativeNodeName ( const String & lang,
const String & name )

Ajoute une traduction pour le nom de l'option.

Ajoute le nom name de l'option correspondant au langage lang. Si une traduction existe déjà pour ce langage, elle est remplacée par celle-ci.

Définition à la ligne 311 du fichier CaseOptionBase.cc.

Références name().

Référencé par updateFromFunction().

◆ addDefaultValue()

void Arcane::CaseOptionBase::addDefaultValue ( const String & category,
const String & value )

Ajoute la valeur par défaut value à la catégorie category.

Définition à la ligne 320 du fichier CaseOptionBase.cc.

Référencé par updateFromFunction().

◆ caseDocument()

ICaseDocument * Arcane::CaseOptionBase::caseDocument ( ) const

Retourne le gestionnaire de document.

Définition à la ligne 148 du fichier CaseOptionBase.cc.

Références Arcane::ICaseMng::caseDocument(), et caseMng().

Référencé par print().

◆ caseDocumentFragment()

ICaseDocumentFragment * Arcane::CaseOptionBase::caseDocumentFragment ( ) const

Retourne le document associé à cette option.

Définition à la ligne 157 du fichier CaseOptionBase.cc.

Référencé par Arcane::CaseOptionExtended::_search(), Arcane::CaseOptionMultiExtended::_search(), Arcane::CaseOptionMultiSimpleT< T >::_search(), Arcane::CaseOptionSimpleT< T >::_search(), et print().

◆ caseMng()

ICaseMng * Arcane::CaseOptionBase::caseMng ( ) const

Gestionnaire de cas.

Définition à la ligne 112 du fichier CaseOptionBase.cc.

Référencé par Arcane::CaseOptionMultiExtended::_search(), Arcane::CaseOptionMultiSimpleT< T >::_search(), caseDocument(), print(), et Arcane::CaseOptionSimpleT< T >::updateFromFunction().

◆ checkIsInitialized()

void Arcane::CaseOptionBase::checkIsInitialized ( ) const
inline

Lève une exception si l'option n'a pas été initialisée.

Définition à la ligne 141 du fichier CaseOptionBase.h.

Références checkIsInitialized().

Référencé par checkIsInitialized().

◆ function()

virtual ICaseFunction * Arcane::CaseOptionBase::function ( ) const
pure virtual

Retourne la fonction liée à cette option ou nullptr s'il n'y en a pas.

Implémenté dans Arcane::CaseOptionExtended, Arcane::CaseOptionMultiEnum, Arcane::CaseOptionMultiExtended, Arcane::CaseOptionMultiSimpleT< T >, et Arcane::CaseOptionSimple.

Références function(), isOptional(), maxOccurs(), et minOccurs().

Référencé par function().

◆ isOptional()

bool Arcane::CaseOptionBase::isOptional ( ) const

Permet de savoir si une option est optionnelle.

Définition à la ligne 232 du fichier CaseOptionBase.cc.

Référencé par Arcane::CaseOptionMultiExtended::_search(), Arcane::CaseOptionMultiSimpleT< T >::_search(), et function().

◆ maxOccurs()

Integer Arcane::CaseOptionBase::maxOccurs ( ) const

Nombre maximum d'occurences (pour une option multiple) (-1 == unbounded)

Définition à la ligne 223 du fichier CaseOptionBase.cc.

Référencé par Arcane::CaseOptionMultiExtended::_search(), Arcane::CaseOptionMultiSimpleT< T >::_search(), et function().

◆ minOccurs()

Integer Arcane::CaseOptionBase::minOccurs ( ) const

Nombre minimum d'occurences (pour une option multiple)

Définition à la ligne 214 du fichier CaseOptionBase.cc.

Référencé par Arcane::CaseOptionMultiExtended::_search(), Arcane::CaseOptionMultiSimpleT< T >::_search(), et function().

◆ name()

String Arcane::CaseOptionBase::name ( ) const

Retourne le nom de l'option correspondant au langage du jeu de données.

Définition à la ligne 205 du fichier CaseOptionBase.cc.

Référencé par Arcane::CaseOptionExtended::_search(), Arcane::CaseOptionMultiExtended::_search(), Arcane::CaseOptionMultiSimpleT< T >::_search(), Arcane::CaseOptionSimpleT< T >::_search(), addAlternativeNodeName(), updateFromFunction(), Arcane::CaseOptionSimpleT< T >::updateFromFunction(), et Arcane::CaseOptionSimple::xpathFullName().

◆ parentOptionList()

ICaseOptionList * Arcane::CaseOptionBase::parentOptionList ( ) const

OptionList parent.

Définition à la ligne 121 du fichier CaseOptionBase.cc.

Référencé par Arcane::CaseOptionExtended::_search(), Arcane::CaseOptionMultiExtended::_search(), et print().

◆ print()

virtual void Arcane::CaseOptionBase::print ( const String & lang,
std::ostream & o ) const
pure virtual

Imprime la valeur de l'option dans le langage lang,sur le flot o.

Implémenté dans Arcane::CaseOptionEnum, Arcane::CaseOptionExtended, Arcane::CaseOptionMultiEnum, Arcane::CaseOptionMultiExtended, Arcane::CaseOptionMultiSimpleT< T >, Arcane::CaseOptionSimpleT< T >, Arcane::CaseOptionSimpleT< bool >, Arcane::CaseOptionSimpleT< bool >, Arcane::CaseOptionSimpleT< BoolArray >, Arcane::CaseOptionSimpleT< BoolArray >, Arcane::CaseOptionSimpleT< Int32 >, Arcane::CaseOptionSimpleT< Int32 >, Arcane::CaseOptionSimpleT< Int32Array >, Arcane::CaseOptionSimpleT< Int32Array >, Arcane::CaseOptionSimpleT< Int64 >, Arcane::CaseOptionSimpleT< Int64 >, Arcane::CaseOptionSimpleT< Int64Array >, Arcane::CaseOptionSimpleT< Int64Array >, Arcane::CaseOptionSimpleT< Integer >, Arcane::CaseOptionSimpleT< Integer >, Arcane::CaseOptionSimpleT< IntegerArray >, Arcane::CaseOptionSimpleT< IntegerArray >, Arcane::CaseOptionSimpleT< Real >, Arcane::CaseOptionSimpleT< Real >, Arcane::CaseOptionSimpleT< Real2 >, Arcane::CaseOptionSimpleT< Real2 >, Arcane::CaseOptionSimpleT< Real2Array >, Arcane::CaseOptionSimpleT< Real2Array >, Arcane::CaseOptionSimpleT< Real2x2 >, Arcane::CaseOptionSimpleT< Real2x2 >, Arcane::CaseOptionSimpleT< Real2x2Array >, Arcane::CaseOptionSimpleT< Real2x2Array >, Arcane::CaseOptionSimpleT< Real3 >, Arcane::CaseOptionSimpleT< Real3 >, Arcane::CaseOptionSimpleT< Real3Array >, Arcane::CaseOptionSimpleT< Real3Array >, Arcane::CaseOptionSimpleT< Real3x3 >, Arcane::CaseOptionSimpleT< Real3x3 >, Arcane::CaseOptionSimpleT< Real3x3Array >, Arcane::CaseOptionSimpleT< Real3x3Array >, Arcane::CaseOptionSimpleT< RealArray >, Arcane::CaseOptionSimpleT< RealArray >, Arcane::CaseOptionSimpleT< String >, Arcane::CaseOptionSimpleT< String >, Arcane::CaseOptionSimpleT< StringArray >, et Arcane::CaseOptionSimpleT< StringArray >.

Références caseDocument(), caseDocumentFragment(), caseMng(), parentOptionList(), rootElement(), setRootElement(), subDomain(), et traceMng().

◆ rootElement()

XmlNode Arcane::CaseOptionBase::rootElement ( ) const

Retourne l'élément racine du DOM.

Définition à la ligne 302 du fichier CaseOptionBase.cc.

Référencé par Arcane::CaseOptionExtended::_search(), Arcane::CaseOptionMultiExtended::_search(), Arcane::CaseOptionMultiSimpleT< T >::_search(), Arcane::CaseOptionSimpleT< T >::_search(), print(), et Arcane::CaseOptionSimple::xpathFullName().

◆ search()

void Arcane::CaseOptionBase::search ( bool is_phase1)

Récupère la valeur du fichier de configuration pour la variable.

Définition à la ligne 185 du fichier CaseOptionBase.cc.

◆ setRootElement()

void Arcane::CaseOptionBase::setRootElement ( const XmlNode & root_element)

Positionne l'élément racine à root_element.

Définition à la ligne 293 du fichier CaseOptionBase.cc.

Référencé par print().

◆ subDomain()

ISubDomain * Arcane::CaseOptionBase::subDomain ( ) const

Gestionnaire de sous-domaine.

Définition à la ligne 139 du fichier CaseOptionBase.cc.

Référencé par print().

◆ traceMng()

ITraceMng * Arcane::CaseOptionBase::traceMng ( ) const

Gestionnaire de traces.

Définition à la ligne 130 du fichier CaseOptionBase.cc.

Référencé par Arcane::CaseOptionExtended::_search(), Arcane::CaseOptionMultiExtended::_search(), et print().

◆ translatedName()

String Arcane::CaseOptionBase::translatedName ( const String & lang) const

Nom dans la langue lang de l'option. Retourne name() si pas de traduction.

Définition à la ligne 279 du fichier CaseOptionBase.cc.

Références Arcane::String::null().

◆ trueName()

String Arcane::CaseOptionBase::trueName ( ) const

Retourne le vrai nom (non traduit) de l'option.

Définition à la ligne 196 du fichier CaseOptionBase.cc.

◆ updateFromFunction()

virtual void Arcane::CaseOptionBase::updateFromFunction ( Real current_time,
Integer current_iteration )
pure virtual

Met à jour la valeur de l'option à partir d'une fonction.

Si l'option n'est pas liée à une table de marche, ne fait rien. Sinon, utilise current_time ou current_iteration suivant le type de paramètre de la fonction pour calculer la nouvelle valeur de l'option. Cette valeur sera ensuite accessible normalement par la méthode operator().

Implémenté dans Arcane::CaseOptionEnum, Arcane::CaseOptionExtended, Arcane::CaseOptionMultiEnum, Arcane::CaseOptionMultiExtended, Arcane::CaseOptionMultiSimpleT< T >, Arcane::CaseOptionSimpleT< T >, Arcane::CaseOptionSimpleT< bool >, Arcane::CaseOptionSimpleT< bool >, Arcane::CaseOptionSimpleT< BoolArray >, Arcane::CaseOptionSimpleT< BoolArray >, Arcane::CaseOptionSimpleT< Int32 >, Arcane::CaseOptionSimpleT< Int32 >, Arcane::CaseOptionSimpleT< Int32Array >, Arcane::CaseOptionSimpleT< Int32Array >, Arcane::CaseOptionSimpleT< Int64 >, Arcane::CaseOptionSimpleT< Int64 >, Arcane::CaseOptionSimpleT< Int64Array >, Arcane::CaseOptionSimpleT< Int64Array >, Arcane::CaseOptionSimpleT< Integer >, Arcane::CaseOptionSimpleT< Integer >, Arcane::CaseOptionSimpleT< IntegerArray >, Arcane::CaseOptionSimpleT< IntegerArray >, Arcane::CaseOptionSimpleT< Real >, Arcane::CaseOptionSimpleT< Real >, Arcane::CaseOptionSimpleT< Real2 >, Arcane::CaseOptionSimpleT< Real2 >, Arcane::CaseOptionSimpleT< Real2Array >, Arcane::CaseOptionSimpleT< Real2Array >, Arcane::CaseOptionSimpleT< Real2x2 >, Arcane::CaseOptionSimpleT< Real2x2 >, Arcane::CaseOptionSimpleT< Real2x2Array >, Arcane::CaseOptionSimpleT< Real2x2Array >, Arcane::CaseOptionSimpleT< Real3 >, Arcane::CaseOptionSimpleT< Real3 >, Arcane::CaseOptionSimpleT< Real3Array >, Arcane::CaseOptionSimpleT< Real3Array >, Arcane::CaseOptionSimpleT< Real3x3 >, Arcane::CaseOptionSimpleT< Real3x3 >, Arcane::CaseOptionSimpleT< Real3x3Array >, Arcane::CaseOptionSimpleT< Real3x3Array >, Arcane::CaseOptionSimpleT< RealArray >, Arcane::CaseOptionSimpleT< RealArray >, Arcane::CaseOptionSimpleT< String >, Arcane::CaseOptionSimpleT< String >, Arcane::CaseOptionSimpleT< StringArray >, et Arcane::CaseOptionSimpleT< StringArray >.

Références addAlternativeNodeName(), addDefaultValue(), name(), et updateFromFunction().

Référencé par updateFromFunction().

◆ visit()

virtual void Arcane::CaseOptionBase::visit ( ICaseDocumentVisitor * visitor) const
pure virtual

Applique le visiteur sur cette option.

Implémenté dans Arcane::CaseOptionEnum, Arcane::CaseOptionExtended, Arcane::CaseOptionMultiEnum, Arcane::CaseOptionMultiExtended, Arcane::CaseOptionMultiSimpleT< T >, et Arcane::CaseOptionSimple.

Références visit().

Référencé par visit().

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