Enumerated data set option. More...

#include <arcane/core/CaseOptionEnum.h>

Inheritance diagram for Arcane::CaseOptionEnum:

Collaboration diagram for Arcane::CaseOptionEnum:

Public Member Functions
	CaseOptionEnum (const CaseOptionBuildInfo &cob, const String &type_name)
virtual void	print (const String &lang, std::ostream &o) const
	Prints the option value in the language lang, to the stream o.
virtual void	updateFromFunction (Real current_time, Integer current_iteration)
	Updates the option value from a function.
void	addEnumValue (CaseOptionEnumValue *value, bool do_clone)
CaseOptionEnumValues *	enumValues () const
virtual void	visit (ICaseDocumentVisitor *visitor) const
	Applies the visitor to this option.
int	enumValueAsInt () const
Public Member Functions inherited from Arcane::CaseOptionSimple
	CaseOptionSimple (const CaseOptionBuildInfo &cob)
	CaseOptionSimple (const CaseOptionBuildInfo &cob, const String &physical_unit)
bool	isPresent () const
	Returns true if the option is present.
	ARCANE_DEPRECATED_LONG_TERM ("Y2022: Do not access XML item from option") XmlNode element() const
	Returns the element of the option.
ICaseFunction *	function () const override
	Function associated with this option (0 if none).
virtual IStandardFunction *	standardFunction () const
	Standard function associated with this option (0 if none).
bool	hasChangedSinceLastIteration () const
	Indicates if the value has changed since the last iteration.
String	xpathFullName () const
	Full name in the format provided by the XPath standard.
String	defaultPhysicalUnit () const
	Default physical unit for this option (null if no unit), specified in the .axl file.
String	physicalUnit () const
	Physical unit specified in the data set (null if no unit).
IPhysicalUnitConverter *	physicalUnitConverter () const
	Physical unit converter.
bool	isOptional () const
	Indicates if the option is optional.
bool	hasValidValue () const
	Indicates if the option has an invalid value.
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 void	_search (bool is_phase1)
virtual bool	_allowPhysicalUnit ()
virtual void	_setOptionValue (int v)=0
	Sets the option value to v.
virtual int	_optionValue () const =0
	Returns the option value.
void	_setEnumDefaultValue (int def_value)
Protected Member Functions inherited from Arcane::CaseOptionSimple
void	_search (bool is_phase1) override
void	_setChangedSinceLastIteration (bool has_changed)
void	_searchFunction (XmlNode &velem)
void	_setPhysicalUnit (const String &value)
void	_setHasValidValue (bool v)
XmlNode	_element () const
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

Private Member Functions
void	_updateFromFunction (Real current_time, Integer current_iteration)

Private Attributes
String	m_type_name
	Enumeration name.
CaseOptionEnumValues *	m_enum_values

Additional Inherited Members
Static Protected Member Functions inherited from Arcane::CaseOptionSimple
static String	_convertFunctionRealToString (ICaseFunction *func, Real t)
static String	_convertFunctionIntegerToString (ICaseFunction *func, Integer t)

Detailed Description

Enumerated data set option.

Definition at line 162 of file CaseOptionEnum.h.

Constructor & Destructor Documentation

◆ CaseOptionEnum()

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

Definition at line 210 of file CaseOptionEnum.cc.

◆ ~CaseOptionEnum()

Arcane::CaseOptionEnum::~CaseOptionEnum ( )

Definition at line 221 of file CaseOptionEnum.cc.

Member Function Documentation

◆ _allowPhysicalUnit()

virtual bool Arcane::CaseOptionEnum::_allowPhysicalUnit ( )

inlineprotectedvirtual

Implements Arcane::CaseOptionSimple.

Definition at line 192 of file CaseOptionEnum.h.

◆ _optionValue()

virtual int Arcane::CaseOptionEnum::_optionValue ( ) const

protectedpure virtual

Returns the option value.

Implemented in Arcane::CaseOptionEnumT< EnumType >, Arcane::CaseOptionEnumT< Arcane::eMeshCellDimensionKind >, Arcane::CaseOptionEnumT< MetisCallStrategy >, and Arcane::CaseOptionEnumT< MetisEmptyPartitionStrategy >.

Referenced by print().

Here is the caller graph for this function:

◆ _search()

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

protectedvirtual

Implements Arcane::CaseOptionBase.

Definition at line 230 of file CaseOptionEnum.cc.

◆ _setEnumDefaultValue()

void Arcane::CaseOptionEnum::_setEnumDefaultValue ( int def_value )

protected

Definition at line 276 of file CaseOptionEnum.cc.

◆ _setOptionValue()

virtual void Arcane::CaseOptionEnum::_setOptionValue ( int v )

protectedpure virtual

Sets the option value to v.

Implemented in Arcane::CaseOptionEnumT< EnumType >, Arcane::CaseOptionEnumT< Arcane::eMeshCellDimensionKind >, Arcane::CaseOptionEnumT< MetisCallStrategy >, and Arcane::CaseOptionEnumT< MetisEmptyPartitionStrategy >.

◆ _updateFromFunction()

void Arcane::CaseOptionEnum::_updateFromFunction	(	Real	current_time,
		Integer	current_iteration )

private

Definition at line 314 of file CaseOptionEnum.cc.

◆ addEnumValue()

void Arcane::CaseOptionEnum::addEnumValue	(	CaseOptionEnumValue *	value,
		bool	do_clone )

inline

Definition at line 178 of file CaseOptionEnum.h.

◆ enumValueAsInt()

int Arcane::CaseOptionEnum::enumValueAsInt ( ) const

inline

Definition at line 186 of file CaseOptionEnum.h.

◆ enumValues()

CaseOptionEnumValues * Arcane::CaseOptionEnum::enumValues ( ) const

inline

Definition at line 182 of file CaseOptionEnum.h.

◆ print()

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

virtual

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

Implements Arcane::CaseOptionBase.

Definition at line 294 of file CaseOptionEnum.cc.

References _optionValue().

Here is the call graph for this function:

◆ updateFromFunction()

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

inlinevirtual

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 173 of file CaseOptionEnum.h.

◆ visit()

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

virtual

Applies the visitor to this option.

Implements Arcane::CaseOptionBase.

Definition at line 305 of file CaseOptionEnum.cc.

Member Data Documentation

◆ m_enum_values

CaseOptionEnumValues* Arcane::CaseOptionEnum::m_enum_values

private

Definition at line 206 of file CaseOptionEnum.h.

◆ m_type_name

String Arcane::CaseOptionEnum::m_type_name

private

Enumeration name.

Definition at line 205 of file CaseOptionEnum.h.

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CaseOptionEnum()

◆ ~CaseOptionEnum()

Member Function Documentation

◆ _allowPhysicalUnit()

◆ _optionValue()

◆ _search()

◆ _setEnumDefaultValue()

◆ _setOptionValue()

◆ _updateFromFunction()

◆ addEnumValue()

◆ enumValueAsInt()

◆ enumValues()

◆ print()

◆ updateFromFunction()

◆ visit()

Member Data Documentation

◆ m_enum_values

◆ m_type_name