Référence de la classe Arcane::CaseOptionMultiExtended

Option du jeu de donnée de type liste de types étendus. Plus de détails...

#include <arcane/core/CaseOptionExtended.h>

Fonctions membres publiques
	CaseOptionMultiExtended (const CaseOptionBuildInfo &cob, const String &type_name)
void	print (const String &lang, std::ostream &o) const override
	Imprime la valeur de l'option dans le langage lang,sur le flot o.
ICaseFunction *	function () const override
	Retourne la fonction liée à cette option ou nullptr s'il n'y en a pas.
void	updateFromFunction (Real, Integer) override
	Met à jour la valeur de l'option à partir d'une fonction.
void	visit (ICaseDocumentVisitor *visitor) const override
	Applique le visiteur sur cette option.
Fonctions membres publiques hérités de Arcane::CaseOptionBase
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.
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.
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.
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.
void	checkIsInitialized () const
	Lève une exception si l'option n'a pas été initialisée.

Fonctions membres protégées
virtual bool	_tryToConvert (const String &s, Integer pos)=0
virtual void	_allocate (Integer size)=0
virtual bool	_allowPhysicalUnit ()
virtual Integer	_nbElem () const =0
String	_typeName () const
void	_search (bool is_phase1) override
	Cherche la valeur de l'option dans le jeu de données.
Fonctions membres protégées hérités de Arcane::CaseOptionBase
	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)
void	_setIsInitialized ()
bool	_isInitialized () const
void	_checkIsInitialized () const
void	_checkMinMaxOccurs (Integer nb_occur)
String	_xpathFullName () const

Description détaillée

Option du jeu de donnée de type liste de types étendus.

Définition à la ligne 142 du fichier CaseOptionExtended.h.

Documentation des constructeurs et destructeur

CaseOptionMultiExtended()

Arcane::CaseOptionMultiExtended::CaseOptionMultiExtended ( const CaseOptionBuildInfo & cob, const String & type_name )

inline

Définition à la ligne 147 du fichier CaseOptionExtended.h.

~CaseOptionMultiExtended()

Arcane::CaseOptionMultiExtended::~CaseOptionMultiExtended ( )

inline

Définition à la ligne 149 du fichier CaseOptionExtended.h.

Documentation des fonctions membres

_allowPhysicalUnit()

virtual bool Arcane::CaseOptionMultiExtended::_allowPhysicalUnit ( )

inlineprotectedvirtual

Définition à la ligne 162 du fichier CaseOptionExtended.h.

_search()

void Arcane::CaseOptionMultiExtended::_search ( bool is_phase1 )

overrideprotectedvirtual

Cherche la valeur de l'option dans le jeu de données.

La valeur trouvée est stockée dans m_value.

Si la valeur n'est pas présente dans le jeu de données, regarde s'il existe une valeur par défaut et utilise cette dernière.

Implémente Arcane::CaseOptionBase.

Définition à la ligne 51 du fichier CaseOptionExtended.cc.

Références Arcane::CaseOptionBase::_defaultValue(), Arcane::CaseOptionError::addInvalidTypeError(), Arcane::CaseOptionError::addOptionNotFoundError(), Arcane::ICaseMng::application(), Arcane::IApplication::applicationInfo(), Arcane::CaseOptionBase::caseDocumentFragment(), Arcane::CaseOptionBase::caseMng(), Arcane::XmlNode::children(), Arcane::ApplicationInfo::commandLineArguments(), Arcane::AbstractArray< T >::contains(), Arcane::AbstractArray< T >::empty(), Arcane::ParameterList::getParameterCaseOption(), Arcane::ITraceMng::info(), Arcane::CaseOptionBase::isOptional(), Arcane::CaseOptionBase::maxOccurs(), Arcane::ICaseOptionList::meshHandle(), Arcane::CaseOptionBase::minOccurs(), Arcane::CaseOptionBase::name(), Arcane::String::null(), Arcane::XmlNode::null(), Arcane::CommandLineArguments::parameters(), Arcane::CaseOptionBase::parentOptionList(), Arcane::CaseOptionBase::rootElement(), Arcane::StringBuilder::toString(), Arcane::CaseOptionBase::traceMng(), et Arcane::XmlNode::value().

_typeName()

String Arcane::CaseOptionMultiExtended::_typeName ( ) const

inlineprotected

Définition à la ligne 164 du fichier CaseOptionExtended.h.

function()

ICaseFunction * Arcane::CaseOptionMultiExtended::function ( ) const

inlineoverridevirtual

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

Implémente Arcane::CaseOptionBase.

Définition à la ligne 154 du fichier CaseOptionExtended.h.

print()

void Arcane::CaseOptionMultiExtended::print ( const String & lang, std::ostream & o ) const

overridevirtual

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

Implémente Arcane::CaseOptionBase.

Définition à la ligne 180 du fichier CaseOptionExtended.cc.

updateFromFunction()

void Arcane::CaseOptionMultiExtended::updateFromFunction ( Real current_time, Integer current_iteration )

inlineoverridevirtual

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émente Arcane::CaseOptionBase.

Définition à la ligne 155 du fichier CaseOptionExtended.h.

visit()

void Arcane::CaseOptionMultiExtended::visit ( ICaseDocumentVisitor * visitor ) const

overridevirtual

Applique le visiteur sur cette option.

Implémente Arcane::CaseOptionBase.

Définition à la ligne 191 du fichier CaseOptionExtended.cc.

---

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

• CaseOptionExtended.h
• CaseOptionExtended.cc