Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::CaseOptionMultiExtended Class Referenceabstract
CaseOption

Option for the extended list of types dataset. More...

#include <arcane/core/CaseOptionExtended.h>

Public Member Functions

 CaseOptionMultiExtended (const CaseOptionBuildInfo &cob, const String &type_name)
void print (const String &lang, std::ostream &o) const override
 Prints the option value in the language lang, to the stream o.
ICaseFunction * function () const override
 Returns the function linked to this option or nullptr if none exists.
void updateFromFunction (Real, Integer) override
 Updates the option value from a function.
void visit (ICaseDocumentVisitor *visitor) const override
 Applies the visitor to this option.
Public Member Functions inherited from Arcane::CaseOptionBase
String trueName () const
 Returns the true name (untranslated) of the option.
String name () const
 Returns the option name corresponding to the data set language.
String translatedName (const String &lang) const
 Name of the option in the language lang. Returns name() if no translation exists.
void search (bool is_phase1)
 Retrieves the value from the configuration file for the variable.
ICaseMng * caseMng () const
 Case manager.
ICaseOptionList * parentOptionList () const
 Parent OptionList.
ITraceMng * traceMng () const
 Trace manager.
ISubDomain * subDomain () const
 Sub-domain manager.
ICaseDocument * caseDocument () const
 Returns the document manager.
ICaseDocumentFragment * caseDocumentFragment () const
 Returns the document associated with this option.
void setRootElement (const XmlNode &root_element)
 Positions the root element at root_element.
XmlNode rootElement () const
 Returns the root element of the DOM.
Integer minOccurs () const
 Minimum number of occurrences (for a multiple option).
Integer maxOccurs () const
 Maximum number of occurrences (for a multiple option) (-1 == unbounded).
bool isOptional () const
 Allows knowing if an option is optional.
void addAlternativeNodeName (const String &lang, const String &name)
 Adds a translation for the option name.
void addDefaultValue (const String &category, const String &value)
 Adds the default value value to the category category.
void checkIsInitialized () const
 Throws an exception if the option has not been initialized.

Protected Member Functions

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
 Searches for the option value in the data set.
Protected Member Functions inherited from Arcane::CaseOptionBase
 CaseOptionBase (const CaseOptionBuildInfo &cob)
String _defaultValue () const
 Returns the default value of the option or 0 if none exists.
void _setDefaultValue (const String &def_value)
void _setIsInitialized ()
bool _isInitialized () const
void _checkIsInitialized () const
void _checkMinMaxOccurs (Integer nb_occur)
String _xpathFullName () const

Detailed Description

Option for the extended list of types dataset.

Definition at line 148 of file CaseOptionExtended.h.

Constructor & Destructor Documentation

◆ CaseOptionMultiExtended()

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

Definition at line 153 of file CaseOptionExtended.h.

◆ ~CaseOptionMultiExtended()

Arcane::CaseOptionMultiExtended::~CaseOptionMultiExtended ( )
inline

Definition at line 157 of file CaseOptionExtended.h.

Member Function Documentation

◆ _allowPhysicalUnit()

virtual bool Arcane::CaseOptionMultiExtended::_allowPhysicalUnit ( )
inlineprotectedvirtual

Definition at line 170 of file CaseOptionExtended.h.

◆ _search()

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

Searches for the option value in the data set.

The found value is stored in m_value.

If the value is not present in the data set, it checks for a default value and uses it.

Implements Arcane::CaseOptionBase.

Definition at line 49 of file CaseOptionExtended.cc.

References Arcane::CaseOptionBase::_defaultValue(), Arcane::ICaseMng::_internalImpl(), Arcane::CaseOptionError::addInvalidTypeError(), Arcane::CaseOptionError::addOptionNotFoundError(), Arcane::CaseOptionBase::caseDocumentFragment(), Arcane::CaseOptionBase::caseMng(), Arcane::XmlNode::children(), Arcane::AbstractArray< T >::contains(), Arcane::AbstractArray< T >::empty(), 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::CaseOptionBase::parentOptionList(), Arcane::CaseOptionBase::rootElement(), Arcane::StringBuilder::toString(), Arcane::CaseOptionBase::traceMng(), and Arcane::XmlNode::value().

◆ _typeName()

String Arcane::CaseOptionMultiExtended::_typeName ( ) const
inlineprotected

Definition at line 172 of file CaseOptionExtended.h.

◆ function()

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

Returns the function linked to this option or nullptr if none exists.

Implements Arcane::CaseOptionBase.

Definition at line 162 of file CaseOptionExtended.h.

◆ print()

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

Prints the option value in the language lang, to the stream o.

Implements Arcane::CaseOptionBase.

Definition at line 178 of file CaseOptionExtended.cc.

◆ updateFromFunction()

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

Updates the option value from a function.

If the option is not linked to a workflow table, it does nothing. Otherwise, it uses current_time or current_iteration depending on the function parameter type to calculate the new option value. This value will then be normally accessible via the operator() method.

Implements Arcane::CaseOptionBase.

Definition at line 163 of file CaseOptionExtended.h.

◆ visit()

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

Applies the visitor to this option.

Implements Arcane::CaseOptionBase.

Definition at line 189 of file CaseOptionExtended.cc.

The documentation for this class was generated from the following files: