Option for the extended type dataset. More...

#include <arcane/core/CaseOptionExtended.h>

Public Member Functions
	CaseOptionExtendedT (const CaseOptionBuildInfo &cob, const String &type_name)
	operator const T & () const
	Option value.
const T &	value () const
	Option value.
const T &	operator() () const
	Option value.
const T &	valueIfPresentOrArgument (const T &arg_value)
	Returns the value of the option if isPresent()==true or otherwise arg_value.
Public Member Functions inherited from Arcane::CaseOptionExtended
	CaseOptionExtended (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.
void	setDefaultValue (const String &def_value)
	Sets the default value of the option.
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 bool	_tryToConvert (const String &s)
Protected Member Functions inherited from Arcane::CaseOptionExtended
void	_search (bool is_phase1) override
	Searches for the option value in the data set.
bool	_allowPhysicalUnit () override
String	_typeName () const
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

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

template<class T>
class Arcane::CaseOptionExtendedT< T >

Option for the extended type dataset.

This class uses an external function with the prototype:

extern "C++" bool

_caseOptionConvert(const CaseOption&,const String&,T& obj);

Arcane::String

Unicode character string.

Definition arccore/src/base/arccore/base/String.h:70

to retrieve an object of type T from a character string. This function returns true if such an object is not found. If the object is found, it is stored in obj.

Definition at line 94 of file CaseOptionExtended.h.

Constructor & Destructor Documentation

◆ CaseOptionExtendedT()

template<class T>

Arcane::CaseOptionExtendedT< T >::CaseOptionExtendedT	(	const CaseOptionBuildInfo &	cob,
		const String &	type_name )

inline

Definition at line 99 of file CaseOptionExtended.h.

Member Function Documentation

◆ _tryToConvert()

template<class T>

virtual bool Arcane::CaseOptionExtendedT< T >::_tryToConvert ( const String & s )

inlineprotectedvirtual

Implements Arcane::CaseOptionExtended.

Definition at line 127 of file CaseOptionExtended.h.

◆ operator const T &()

template<class T>

Arcane::CaseOptionExtendedT< T >::operator const T & ( ) const

inline

Option value.

Definition at line 106 of file CaseOptionExtended.h.

References value().

◆ operator()()

template<class T>

const T & Arcane::CaseOptionExtendedT< T >::operator() ( ) const

inline

Option value.

Definition at line 116 of file CaseOptionExtended.h.

References value().

◆ value()

template<class T>

const T & Arcane::CaseOptionExtendedT< T >::value ( ) const

inline

Option value.

Definition at line 109 of file CaseOptionExtended.h.

Referenced by operator const T &(), and operator()().

◆ valueIfPresentOrArgument()

template<class T>

const T & Arcane::CaseOptionExtendedT< T >::valueIfPresentOrArgument ( const T & arg_value )

inline

Returns the value of the option if isPresent()==true or otherwise arg_value.

Definition at line 119 of file CaseOptionExtended.h.

References Arcane::CaseOptionSimple::isPresent().

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

CaseOptionExtended.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CaseOptionExtendedT()

Member Function Documentation

◆ _tryToConvert()

◆ operator const T &()

◆ operator()()

◆ value()

◆ valueIfPresentOrArgument()