Option du jeu de données de type liste de types simples (réel, entier, booléen, ...). Plus de détails...

#include <arcane/core/CaseOptionSimple.h>

Graphe d'héritage de Arcane::CaseOptionMultiSimpleT< T >:

Graphe de collaboration de Arcane::CaseOptionMultiSimpleT< T >:

Types publics
using	Type = typename CaseOptionTraitsT< T >::ContainerType
	Type de la valeur de l'option.

using	ReferenceType = typename CaseOptionTraitsT< T >::ReferenceType

using	ConstReferenceType = typename CaseOptionTraitsT< T >::ConstReferenceType

using	ArrayViewType = typename CaseOptionTraitsT< T >::ArrayViewType
	Type de la vue sur les valeurs de l'option.

using	ConstArrayViewType = typename CaseOptionTraitsT< T >::ConstArrayViewType
	Type de la vue constante sur les valeurs de l'option.

Types publics hérités de Arccore::ArrayView< T >
using	ThatClass = ArrayView< T >

typedef T	value_type
	Type des éléments du tableau.

typedef value_type *	pointer
	Type pointeur d'un élément du tableau.

typedef const value_type *	const_pointer
	Type pointeur constant d'un élément du tableau.

typedef ArrayIterator< pointer >	iterator
	Type de l'itérateur sur un élément du tableau.

typedef ArrayIterator< const_pointer >	const_iterator
	Type de l'itérateur constant sur un élément du tableau.

typedef value_type &	reference
	Type référence d'un élément du tableau.

typedef const value_type &	const_reference
	Type référence constante d'un élément du tableau.

typedef Integer	size_type
	Type indexant le tableau.

typedef std::ptrdiff_t	difference_type
	Type d'une distance entre itérateur éléments du tableau.

typedef IterT< ArrayView< T > >	iter
	Type d'un itérateur sur tout le tableau.

typedef ConstIterT< ArrayView< T > >	const_iter
	Type d'un itérateur constant sur tout le tableau.

typedef std::reverse_iterator< iterator >	reverse_iterator

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator

Fonctions membres publiques
	CaseOptionMultiSimpleT (const CaseOptionBuildInfo &cob)

	CaseOptionMultiSimpleT (const CaseOptionBuildInfo &cob, const String &physical_unit)

ArrayView< T >	operator() ()

const ArrayView< T >	operator() () const

	operator ArrayView< T > ()
	Conversion vers la vue constante.

	operator ConstArrayView< T > () const
	Conversion vers la vue constante.

ConstArrayViewType	view () const
	Vue constante sur les éléments de l'option.

ArrayViewType	view ()
	Vue sur les éléments de l'option.

ConstReferenceType	operator[] (Integer i) const

ReferenceType	operator[] (Integer i)

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.

ConstArrayView< T >	values () const

const T &	value (Integer index) const

Integer	size () const

void	visit (ICaseDocumentVisitor *visitor) const override
	Applique le visiteur sur cette option.

Fonctions membres publiques hérités de Arcane::CaseOptionMultiSimple
	CaseOptionMultiSimple (const CaseOptionBuildInfo &cob)

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)

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 publiques hérités de Arccore::ArrayView< T >
constexpr	ArrayView () noexcept
	Construit une vue vide.

	ArrayView (const ArrayView< T > &from)=default
	Constructeur de recopie depuis une autre vue.

constexpr	ArrayView (Integer asize, pointer ptr) noexcept
	Construit une vue sur une zone mémoire commencant par ptr et.

template<std::size_t N>
constexpr	ArrayView (std::array< T, N > &v)
	Construit une vue sur une zone mémoire commencant par ptr et contenant asize éléments.

ArrayView< T > &	operator= (const ArrayView< T > &from)=default
	Opérateur de recopie.

template<std::size_t N>
constexpr ArrayView< T > &	operator= (std::array< T, N > &from)

constexpr reference	operator[] (Integer i)
	i-ème élément du tableau.

constexpr const_reference	operator[] (Integer i) const
	i-ème élément du tableau.

constexpr reference	operator() (Integer i)
	i-ème élément du tableau.

constexpr const_reference	operator() (Integer i) const
	i-ème élément du tableau.

constexpr const_reference	item (Integer i) const
	i-ème élément du tableau.

constexpr void	setItem (Integer i, const_reference v)
	Positionne le i-ème élément du tableau.

constexpr Integer	size () const noexcept
	Retourne la taille du tableau.

constexpr Integer	length () const noexcept
	Nombre d'éléments du tableau.

constexpr iterator	begin () noexcept
	Itérateur sur le premier élément du tableau.

constexpr iterator	end () noexcept
	Itérateur sur le premier élément après la fin du tableau.

constexpr const_iterator	begin () const noexcept
	Itérateur constant sur le premier élément du tableau.

constexpr const_iterator	end () const noexcept
	Itérateur constant sur le premier élément après la fin du tableau.

constexpr reverse_iterator	rbegin () noexcept
	Itérateur inverse sur le premier élément du tableau.

constexpr const_reverse_iterator	rbegin () const noexcept
	Itérateur inverse sur le premier élément du tableau.

constexpr reverse_iterator	rend () noexcept
	Itérateur inverse sur le premier élément après la fin du tableau.

constexpr const_reverse_iterator	rend () const noexcept
	Itérateur inverse sur le premier élément après la fin du tableau.

ArrayRange< pointer >	range ()
	Intervalle d'itération du premier au dernièr élément.

ArrayRange< const_pointer >	range () const
	Intervalle d'itération du premier au dernièr élément.

constexpr pointer	ptrAt (Integer index)
	Addresse du index-ème élément.

constexpr const_pointer	ptrAt (Integer index) const
	Addresse du index-ème élément.

constexpr const_reference	at (Integer i) const

void	setAt (Integer i, const_reference value)

void	fill (const T &o) noexcept
	Remplit le tableau avec la valeur o.

constexpr ConstArrayView< T >	constView () const noexcept
	Vue constante sur cette vue.

constexpr ArrayView< T >	subView (Integer abegin, Integer asize) noexcept
	Sous-vue à partir de l'élément abegin et contenant asize éléments.

constexpr ThatClass	subPart (Integer abegin, Integer asize) noexcept
	Sous-vue à partir de l'élément abegin et contenant asize éléments.

constexpr ConstArrayView< T >	subConstView (Integer abegin, Integer asize) const noexcept
	Sous-vue constante à partir de l'élément `abegin` et contenant `asize` éléments.

constexpr ArrayView< T >	subViewInterval (Integer index, Integer nb_interval)
	Sous-vue correspondant à l'interval index sur nb_interval.

constexpr ThatClass	subPartInterval (Integer index, Integer nb_interval)
	Sous-vue correspondant à l'interval index sur nb_interval.

template<class U >
void	copy (const U &copy_array)
	Recopie le tableau copy_array dans l'instance.

constexpr bool	empty () const noexcept
	Retourne true si le tableau est vide (dimension nulle)

bool	contains (const_reference v) const
	true si le tableau contient l'élément de valeur v

void	setArray (const ArrayView< T > &v) noexcept

constexpr pointer	unguardedBasePointer () noexcept
	Pointeur sur le début de la vue.

constexpr const_pointer	unguardedBasePointer () const noexcept
	Pointeur constant sur le début de la vue.

constexpr const_pointer	data () const noexcept
	Pointeur sur le début de la vue.

constexpr pointer	data () noexcept
	Pointeur constant sur le début de la vue.

Fonctions membres protégées
void	_search (bool is_phase1) override
	Cherche la valeur de l'option dans le jeu de donnée.

virtual bool	_allowPhysicalUnit ()

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

Fonctions membres protégées hérités de Arccore::ArrayView< T >
constexpr pointer	_ptr () noexcept
	Retourne un pointeur sur le tableau.

constexpr const_pointer	_ptr () const noexcept
	Retourne un pointeur sur le tableau.

void	_setArray (pointer v, Integer s) noexcept
	Modifie le pointeur et la taille du tableau.

void	_setPtr (pointer v) noexcept
	Modifie le pointeur du début du tableau.

void	_setSize (Integer s) noexcept
	Modifie la taille du tableau.

Membres hérités additionnels
Fonctions membres publiques statiques hérités de Arccore::ArrayView< T >
static constexpr ThatClass	create (pointer ptr, Integer asize) noexcept
	Construit une vue sur une zone mémoire commencant par ptr et.

Description détaillée

template<class T>
class Arcane::CaseOptionMultiSimpleT< T >

Option du jeu de données de type liste de types simples (réel, entier, booléen, ...).

Avertissement: L'utilisation de la classe de base ArrayView<T> est obsolète et ne doit plus être utilisée. La méthode view() permet de récupérer une vue sur les valeurs de l'option.

Définition à la ligne 318 du fichier CaseOptionSimple.h.

Documentation des définitions de type membres

◆ ArrayViewType

template<class T >

using Arcane::CaseOptionMultiSimpleT< T >::ArrayViewType = typename CaseOptionTraitsT<T>::ArrayViewType

Type de la vue sur les valeurs de l'option.

Définition à la ligne 333 du fichier CaseOptionSimple.h.

◆ ConstArrayViewType

template<class T >

using Arcane::CaseOptionMultiSimpleT< T >::ConstArrayViewType = typename CaseOptionTraitsT<T>::ConstArrayViewType

Type de la vue constante sur les valeurs de l'option.

Définition à la ligne 335 du fichier CaseOptionSimple.h.

◆ ConstReferenceType

template<class T >

using Arcane::CaseOptionMultiSimpleT< T >::ConstReferenceType = typename CaseOptionTraitsT<T>::ConstReferenceType

Définition à la ligne 331 du fichier CaseOptionSimple.h.

◆ ReferenceType

template<class T >

using Arcane::CaseOptionMultiSimpleT< T >::ReferenceType = typename CaseOptionTraitsT<T>::ReferenceType

Définition à la ligne 330 du fichier CaseOptionSimple.h.

◆ Type

template<class T >

using Arcane::CaseOptionMultiSimpleT< T >::Type = typename CaseOptionTraitsT<T>::ContainerType

Type de la valeur de l'option.

Définition à la ligne 329 du fichier CaseOptionSimple.h.

Documentation des constructeurs et destructeur

◆ CaseOptionMultiSimpleT() [1/2]

template<typename T >

Arcane::CaseOptionMultiSimpleT< T >::CaseOptionMultiSimpleT ( const CaseOptionBuildInfo & cob )

Définition à la ligne 587 du fichier CaseOptionSimple.cc.

◆ CaseOptionMultiSimpleT() [2/2]

template<typename T >

Arcane::CaseOptionMultiSimpleT< T >::CaseOptionMultiSimpleT	(	const CaseOptionBuildInfo &	cob,
		const String &	physical_unit
	)

Définition à la ligne 596 du fichier CaseOptionSimple.cc.

◆ ~CaseOptionMultiSimpleT()

template<typename T >

Arcane::CaseOptionMultiSimpleT< T >::~CaseOptionMultiSimpleT ( )

Définition à la ligne 606 du fichier CaseOptionSimple.cc.

Documentation des fonctions membres

◆ _allowPhysicalUnit()

template<typename T >

bool Arcane::CaseOptionMultiSimpleT< T >::_allowPhysicalUnit ( )

protectedvirtual

Définition à la ligne 616 du fichier CaseOptionSimple.cc.

◆ _search()

template<typename T >

void Arcane::CaseOptionMultiSimpleT< T >::_search ( bool is_phase1 )

overrideprotectedvirtual

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

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

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

Implémente Arcane::CaseOptionBase.

Définition à la ligne 633 du fichier CaseOptionSimple.cc.

Références Arcane::CaseOptionError::addInvalidTypeError(), Arcane::CaseOptionError::addOptionNotFoundError(), Arcane::XmlNode::null(), Arccore::String::null(), et Arcane::XmlNode::value().

◆ function()

template<class T >

ICaseFunction * Arcane::CaseOptionMultiSimpleT< T >::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 381 du fichier CaseOptionSimple.h.

◆ operator ArrayView< T >()

template<class T >

Arcane::CaseOptionMultiSimpleT< T >::operator ArrayView< T > ( )

inline

Conversion vers la vue constante.

Définition à la ligne 358 du fichier CaseOptionSimple.h.

◆ operator ConstArrayView< T >()

template<class T >

Arcane::CaseOptionMultiSimpleT< T >::operator ConstArrayView< T > ( ) const

inline

Conversion vers la vue constante.

Définition à la ligne 362 du fichier CaseOptionSimple.h.

◆ operator()() [1/2]

template<class T >

ArrayView< T > Arcane::CaseOptionMultiSimpleT< T >::operator() ( )

inline

Définition à la ligne 346 du fichier CaseOptionSimple.h.

◆ operator()() [2/2]

template<class T >

const ArrayView< T > Arcane::CaseOptionMultiSimpleT< T >::operator() ( ) const

inline

Définition à la ligne 351 du fichier CaseOptionSimple.h.

◆ operator[]() [1/2]

template<class T >

ReferenceType Arcane::CaseOptionMultiSimpleT< T >::operator[] ( Integer i )

inline

Définition à la ligne 376 du fichier CaseOptionSimple.h.

◆ operator[]() [2/2]

template<class T >

ConstReferenceType Arcane::CaseOptionMultiSimpleT< T >::operator[] ( Integer i ) const

inline

Définition à la ligne 375 du fichier CaseOptionSimple.h.

◆ print()

template<typename T >

void Arcane::CaseOptionMultiSimpleT< T >::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 676 du fichier CaseOptionSimple.cc.

◆ size()

template<class T >

Integer Arcane::CaseOptionMultiSimpleT< T >::size ( ) const

inline

Définition à la ligne 386 du fichier CaseOptionSimple.h.

◆ updateFromFunction()

template<class T >

void Arcane::CaseOptionMultiSimpleT< T >::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 382 du fichier CaseOptionSimple.h.

◆ value()

template<class T >

const T & Arcane::CaseOptionMultiSimpleT< T >::value ( Integer index ) const

inline

Définition à la ligne 385 du fichier CaseOptionSimple.h.

◆ values()

template<class T >

ConstArrayView< T > Arcane::CaseOptionMultiSimpleT< T >::values ( ) const

inline

Définition à la ligne 384 du fichier CaseOptionSimple.h.

◆ view() [1/2]

template<class T >

ArrayViewType Arcane::CaseOptionMultiSimpleT< T >::view ( )

inline

Vue sur les éléments de l'option.

Définition à la ligne 370 du fichier CaseOptionSimple.h.

◆ view() [2/2]

template<class T >

ConstArrayViewType Arcane::CaseOptionMultiSimpleT< T >::view ( ) const

inline

Vue constante sur les éléments de l'option.

Définition à la ligne 365 du fichier CaseOptionSimple.h.

◆ visit()

template<typename T >

void Arcane::CaseOptionMultiSimpleT< T >::visit ( ICaseDocumentVisitor * visitor ) const

overridevirtual

Applique le visiteur sur cette option.

Implémente Arcane::CaseOptionBase.

Définition à la ligne 687 du fichier CaseOptionSimple.cc.

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

Types publics

Fonctions membres publiques

Fonctions membres protégées

Membres hérités additionnels

Description détaillée

Documentation des définitions de type membres

◆ ArrayViewType

◆ ConstArrayViewType

◆ ConstReferenceType

◆ ReferenceType

◆ Type

Documentation des constructeurs et destructeur

◆ CaseOptionMultiSimpleT() [1/2]

◆ CaseOptionMultiSimpleT() [2/2]

◆ ~CaseOptionMultiSimpleT()

Documentation des fonctions membres

◆ _allowPhysicalUnit()

◆ _search()

◆ function()

◆ operator ArrayView< T >()

◆ operator ConstArrayView< T >()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ print()

◆ size()

◆ updateFromFunction()

◆ value()

◆ values()

◆ view() [1/2]

◆ view() [2/2]

◆ visit()