Graphe d'héritage de Arcane::CaseTable:

Graphe de collaboration de Arcane::CaseTable:

Types publics
enum	eError { ErrNo , ErrBadRange , ErrCanNotConvertParamToRightType , ErrCanNotConvertValueToRightType , ErrNotGreaterThanPrevious , ErrNotLesserThanNext }
	Type des erreurs retournées par la classe. Plus de détails...

enum	eCurveType { CurveUnknown = 0 , CurveConstant = 1 , CurveLinear = 2 }
	Type de la courbe de la table. Plus de détails...

Types publics hérités de Arcane::ICaseFunction
enum	eParamType { ParamUnknown =0 , ParamReal = 1 , ParamInteger = 2 }
	Type d'un paramètre d'une fonction. Plus de détails...

enum	eValueType { ValueUnknown = 0 , ValueReal = 1 , ValueInteger = 2 , ValueBool = 3 , ValueString = 4 , ValueReal3 = 5 }
	Type d'une valeur d'une fonction. Plus de détails...

Fonctions membres publiques
	CaseTable (const CaseFunctionBuildInfo &info, eCurveType curve_type)
	Construit une table de marche du jeu de données.

virtual Integer	nbElement () const
	Nombre d'éléments de la fonction.

virtual void	valueToString (Integer id, String &str) const
	\id ième valeur dans la chaîne str

virtual void	paramToString (Integer id, String &param) const
	\id ième paramètre dans la chaîne str

virtual eError	setParam (Integer id, const String &value)
	Modifie le paramètre de l'élément id.

virtual eError	setValue (Integer id, const String &value)
	Modifie la valeur de l'élément id.

virtual eError	appendElement (const String &param, const String &value)
	Ajoute un élément à la table.

virtual void	insertElement (Integer id)
	Insère un couple (paramètre,valeur) dans la fonction.

virtual void	removeElement (Integer id)
	Supprime un couple (paramètre,valeur) dans la fonction.

template<typename ParamType , typename ValueType >
void	_findValue (ParamType param, ValueType &avalue) const
	Calcul la valeur de la courbe pour le paramètre param. La valeur est stockée dans value.

Fonctions membres publiques hérités de Arcane::CaseFunction
	CaseFunction (const CaseFunctionBuildInfo &info)
	Construit une fonction du jeu de données.

String	name () const override
	nom de la fonction

void	setName (const String &new_name) override
	Positionne le nom de la fonction en new_name.

eParamType	paramType () const override
	Type du paramètre de la fonction.

eValueType	valueType () const override
	Type des valeurs de la fonction.

void	setValueType (eValueType type) override
	Positionne le type des valeurs de la fonction.

void	setTransformValueFunction (const String &str) override
	Affecte une fonction de transformation de la valeur. Pour l'instant, il s'agit juste d'un coefficient multiplicatif. La chaîne str doit pouvoir être convertie en le type de la valeur.

String	transformValueFunction () const override
	Retourne la fonction de transformation de la valeur.

void	setTransformParamFunction (const String &str) override
	Affecte une fonction de transformation du paramètre. Pour l'instant, il s'agit juste d'un coefficient multiplicatif. Il n'est appliqué que pour les paramètre réels. La chaîne str doit pouvoir être convertie en un réel.

String	transformParamFunction () const override
	Fonction de transformation du paramètre.

void	setDeltatCoef (Real v) override
	Positionne la Valeur du coefficient multiplicateur du deltat.

Real	deltatCoef () const override
	Valeur du coefficient multiplicateur du deltat.

Ref< ICaseFunction >	toReference ()

ITraceMng *	traceMng () const

Fonctions membres publiques hérités de Arcane::ICaseFunction
virtual	~ICaseFunction ()=default
	Libère les ressources.

Fonctions membres publiques hérités de Arccore::ReferenceCounterImpl
void	addReference ()

void	removeReference ()

void	_internalAddReference ()

bool	_internalRemoveReference ()

Type de la courbe
virtual eCurveType	curveType () const
	Retourne le type de la courbe de la fonction.

virtual void	setParamType (eParamType type)
	Positionne le type de paramètre de la fonction.

virtual bool	checkIfValid () const
	Vérifie la validité de la fonction.

virtual void	value (Real param, Real &v) const
	Valeur v de l'option pour le paramètre param.

virtual void	value (Real param, Integer &v) const
	Valeur v de l'option pour le paramètre param.

virtual void	value (Real param, bool &v) const
	Valeur v de l'option pour le paramètre param.

virtual void	value (Real param, String &v) const
	Valeur v de l'option pour le paramètre param.

virtual void	value (Real param, Real3 &v) const
	Valeur v de l'option pour le paramètre param.

virtual void	value (Integer param, Real &v) const
	Valeur v de l'option pour le paramètre param.

virtual void	value (Integer param, Integer &v) const
	Valeur v de l'option pour le paramètre param.

virtual void	value (Integer param, bool &v) const

virtual void	value (Integer param, String &v) const
	Valeur v de l'option pour le paramètre param.

virtual void	value (Integer param, Real3 &v) const
	Valeur v de l'option pour le paramètre param.

Membres hérités additionnels
Fonctions membres protégées hérités de Arcane::CaseFunction
template<typename ParamType >
void	_applyParamTransform2 (ParamType &param) const

Real	_applyValueComulTransform (Real v, Real comul) const

Integer	_applyValueComulTransform (Integer v, Integer comul) const

String	_applyValueComulTransform (const String &v, const String &comul) const

bool	_applyValueComulTransform (bool v, bool comul) const

Real3	_applyValueComulTransform (Real3 v, Real3 comul) const

void	_applyValueTransform (Real &value) const

void	_applyValueTransform (Integer &value) const

void	_applyValueTransform (String &value) const

void	_applyValueTransform (Real3 &value) const

void	_applyValueTransform (bool &value) const

template<typename ValueType >
void	_applyValueTransform2 (ValueType &value) const

void	_applyParamTransform (Real &value) const

void	_applyParamTransform (Integer &value) const

Description détaillée

Définition à la ligne 38 du fichier CaseTable.h.

Documentation des énumérations membres

◆ eCurveType

enum Arcane::CaseTable::eCurveType

Type de la courbe de la table.

Valeurs énumérées
CurveUnknown	Type de courbe inconnu.
CurveConstant	Courbe constante par morceau.
CurveLinear	Courbe linéaire par morceau.

Définition à la ligne 63 du fichier CaseTable.h.

◆ eError

enum Arcane::CaseTable::eError

Type des erreurs retournées par la classe.

Valeurs énumérées
ErrBadRange	Indique qu'un indice d'un élément n'est pas valide.
ErrCanNotConvertParamToRightType	Indique que la conversion du paramètre vers le type souhaité est impossible.
ErrCanNotConvertValueToRightType	Indique que la conversion de la valeur vers le type souhaité est impossible.
ErrNotGreaterThanPrevious	Indique que le paramètre n'est pas supérieur au précédent.
ErrNotLesserThanNext	Indique que le paramètre n'est pas inférieur au suivant.

Définition à la ligne 46 du fichier CaseTable.h.

Documentation des constructeurs et destructeur

◆ CaseTable()

Arcane::CaseTable::CaseTable	(	const CaseFunctionBuildInfo &	info,
		eCurveType	curve_type
	)

Construit une table de marche du jeu de données.

Paramètres

curve_type type de la courbe de la table de marche

Définition à la ligne 45 du fichier CaseTable.cc.

Références Arcane::CaseFunctionBuildInfo::m_param_type.

◆ ~CaseTable()

Arcane::CaseTable::~CaseTable ( )

virtual

Définition à la ligne 59 du fichier CaseTable.cc.

Documentation des fonctions membres

◆ _findValue()

template<typename ParamType , typename ValueType >

void Arcane::CaseTable::_findValue	(	ParamType	param,
		ValueType &	avalue
	)		const

Calcul la valeur de la courbe pour le paramètre param. La valeur est stockée dans value.

Valeurs retournées

false	en cas de succès
true	si erreur

Définition à la ligne 336 du fichier CaseTable.cc.

Références ARCANE_FATAL, CurveConstant, CurveLinear, Arcane::math::isEqual(), Arcane::CaseFunction::name(), et nbElement().

◆ appendElement()

CaseTable::eError Arcane::CaseTable::appendElement	(	const String &	param,
		const String &	value
	)

virtual

Ajoute un élément à la table.

Ajoute l'élément (param,value) à la table.

Renvoie: la valeur de l'erreur, ErrNo sinon.

Définition à la ligne 219 du fichier CaseTable.cc.

Références Arccore::AbstractArray< T >::size(), et value().

◆ checkIfValid()

bool Arcane::CaseTable::checkIfValid ( ) const

virtual

Vérifie la validité de la fonction.

Valeurs retournées

true	si la fonction est valide,
false	sinon.

Réimplémentée à partir de Arcane::CaseFunction.

Définition à la ligne 282 du fichier CaseTable.cc.

◆ curveType()

virtual eCurveType Arcane::CaseTable::curveType ( ) const

inlinevirtual

Retourne le type de la courbe de la fonction.

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

◆ insertElement()

void Arcane::CaseTable::insertElement ( Integer id )

virtual

Insère un couple (paramètre,valeur) dans la fonction.

Insère à la position id un couple (paramètre,valeur) identique à celui qui s'y trouvait. Les paramètres suivants sont décalées d'un cran. Il est ensuite possible de modifier ce couple par les méthodes setParam() ou setValue().

Si id est supérieur au nombre d'éléments de la fonction, un élément est ajouté à la fin avec la même valeur que le dernier élément de la fonction.

Définition à la ligne 232 du fichier CaseTable.cc.

Références Arccore::Array< T >::add(), et nbElement().

◆ nbElement()

Integer Arcane::CaseTable::nbElement ( ) const

virtual

Nombre d'éléments de la fonction.

Définition à la ligne 273 du fichier CaseTable.cc.

Référencé par _findValue(), et insertElement().

◆ paramToString()

void Arcane::CaseTable::paramToString	(	Integer	id,
		String &	param
	)		const

virtual

\id ième paramètre dans la chaîne str

Définition à la ligne 94 du fichier CaseTable.cc.

◆ removeElement()

void Arcane::CaseTable::removeElement ( Integer id )

virtual

Supprime un couple (paramètre,valeur) dans la fonction.

Si id est supérieur au nombre d'éléments de la fonction, aucune opération n'est effectuée.

Définition à la ligne 260 du fichier CaseTable.cc.

Références Arccore::Array< T >::remove().

◆ setParam()

CaseTable::eError Arcane::CaseTable::setParam	(	Integer	id,
		const String &	value
	)

virtual

Modifie le paramètre de l'élément id.

Utilise value comme nouvelle valeur pour le paramètre. value doit pourvoir être converti en le type du paramètre.

Renvoie: la valeur de l'erreur, ErrNo sinon.

Définition à la ligne 146 du fichier CaseTable.cc.

◆ setParamType()

void Arcane::CaseTable::setParamType ( eParamType type )

virtual

Positionne le type de paramètre de la fonction.

Réimplémentée à partir de Arcane::CaseFunction.

Définition à la ligne 205 du fichier CaseTable.cc.

Références Arcane::CaseFunction::paramType(), et Arcane::CaseFunction::setParamType().

◆ setValue()

CaseTable::eError Arcane::CaseTable::setValue	(	Integer	id,
		const String &	value
	)

virtual

Modifie la valeur de l'élément id.

Utilise value comme nouvelle valeur. value doit pourvoir être converti en le type de la valeur.

Renvoie: la valeur de l'erreur, ErrNo sinon.

Définition à la ligne 155 du fichier CaseTable.cc.

◆ value() [1/10]

void Arcane::CaseTable::value	(	Integer	param,
		bool &	v
	)		const

virtual

Implémente Arcane::ICaseFunction.

Définition à la ligne 131 du fichier CaseTable.cc.

◆ value() [2/10]

void Arcane::CaseTable::value	(	Integer	param,
		Integer &	v
	)		const

virtual

Valeur v de l'option pour le paramètre param.

Implémente Arcane::ICaseFunction.

Définition à la ligne 127 du fichier CaseTable.cc.

◆ value() [3/10]

void Arcane::CaseTable::value	(	Integer	param,
		Real &	v
	)		const

virtual

Valeur v de l'option pour le paramètre param.

Implémente Arcane::ICaseFunction.

Définition à la ligne 123 du fichier CaseTable.cc.

◆ value() [4/10]

void Arcane::CaseTable::value	(	Integer	param,
		Real3 &	v
	)		const

virtual

Valeur v de l'option pour le paramètre param.

Implémente Arcane::ICaseFunction.

Définition à la ligne 139 du fichier CaseTable.cc.

◆ value() [5/10]

void Arcane::CaseTable::value	(	Integer	param,
		String &	v
	)		const

virtual

Valeur v de l'option pour le paramètre param.

Implémente Arcane::ICaseFunction.

Définition à la ligne 135 du fichier CaseTable.cc.

◆ value() [6/10]

void Arcane::CaseTable::value	(	Real	param,
		bool &	v
	)		const

virtual

Valeur v de l'option pour le paramètre param.

Implémente Arcane::ICaseFunction.

Définition à la ligne 111 du fichier CaseTable.cc.

◆ value() [7/10]

void Arcane::CaseTable::value	(	Real	param,
		Integer &	v
	)		const

virtual

Valeur v de l'option pour le paramètre param.

Implémente Arcane::ICaseFunction.

Définition à la ligne 107 du fichier CaseTable.cc.

◆ value() [8/10]

void Arcane::CaseTable::value	(	Real	param,
		Real &	v
	)		const

virtual

Valeur v de l'option pour le paramètre param.

Implémente Arcane::ICaseFunction.

Définition à la ligne 103 du fichier CaseTable.cc.

Référencé par appendElement().

◆ value() [9/10]

void Arcane::CaseTable::value	(	Real	param,
		Real3 &	v
	)		const

virtual

Valeur v de l'option pour le paramètre param.

Implémente Arcane::ICaseFunction.

Définition à la ligne 119 du fichier CaseTable.cc.

◆ value() [10/10]

void Arcane::CaseTable::value	(	Real	param,
		String &	v
	)		const

virtual

Valeur v de l'option pour le paramètre param.

Implémente Arcane::ICaseFunction.

Définition à la ligne 115 du fichier CaseTable.cc.

◆ valueToString()

void Arcane::CaseTable::valueToString	(	Integer	id,
		String &	str
	)		const

virtual

\id ième valeur dans la chaîne str

Définition à la ligne 82 du fichier CaseTable.cc.

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

Types publics

Fonctions membres publiques

Type de la courbe

Membres hérités additionnels

Description détaillée

Documentation des énumérations membres

◆ eCurveType

◆ eError

Documentation des constructeurs et destructeur

◆ CaseTable()

◆ ~CaseTable()

Documentation des fonctions membres

◆ _findValue()

◆ appendElement()

◆ checkIfValid()

◆ curveType()

◆ insertElement()

◆ nbElement()

◆ paramToString()

◆ removeElement()

◆ setParam()

◆ setParamType()

◆ setValue()

◆ value() [1/10]

◆ value() [2/10]

◆ value() [3/10]

◆ value() [4/10]

◆ value() [5/10]

◆ value() [6/10]

◆ value() [7/10]

◆ value() [8/10]

◆ value() [9/10]

◆ value() [10/10]

◆ valueToString()