Interface d'une fonction du jeu de données. Plus de détails...

#include <arcane/core/ICaseFunction.h>

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

Graphe de collaboration de Arcane::ICaseFunction:

Types publics
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
virtual	~ICaseFunction ()=default
	Libère les ressources.

Nom de la fonction
virtual String	name () const =0
	nom de la fonction

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

Type du paramètre
virtual eParamType	paramType () const =0
	Type du paramètre de la fonction.

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

Type de la valeur
virtual eValueType	valueType () const =0
	Type des valeurs de la fonction.

virtual void	setValueType (eValueType type)=0
	Positionne le type des valeurs de la fonction.

virtual void	setTransformValueFunction (const String &str)=0
	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.

virtual String	transformValueFunction () const =0
	Retourne la fonction de transformation de la valeur.

virtual void	setTransformParamFunction (const String &str)=0
	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.

virtual String	transformParamFunction () const =0
	Fonction de transformation du paramètre.

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

virtual void	setDeltatCoef (Real v)=0
	Positionne la Valeur du coefficient multiplicateur du deltat.

virtual Real	deltatCoef () const =0
	Valeur du coefficient multiplicateur du deltat.

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

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

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

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

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

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

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

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

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

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

Fonctions membres privées
	ARCCORE_DECLARE_REFERENCE_COUNTED_INCLASS_METHODS ()

Description détaillée

Interface d'une fonction du jeu de données.

Une fonction du jeu de données est une fonction mathématique f(x)->y avec x le paramètre et y la valeur.

Dans la version actuelle, une fonction est décrite par morceaux par un ensemble de couples (x,y).

Les méthodes qui permettent d'éditer cette table de marche sont utilisées principalement par l'éditeur du jeu de données. Dans tous les cas, elles ne doivent pas être appelées une fois que le jeu de données complet a été lu (ICaseMng::readCaseOptions).

Définition à la ligne 45 du fichier ICaseFunction.h.

Documentation des énumérations membres

◆ eParamType

enum Arcane::ICaseFunction::eParamType

Type d'un paramètre d'une fonction.

Valeurs énumérées
ParamUnknown	Type de paramètre inconnu.
ParamReal	Paramètre de type Real.
ParamInteger	Paramètre de type Integer.

Définition à la ligne 54 du fichier ICaseFunction.h.

◆ eValueType

enum Arcane::ICaseFunction::eValueType

Type d'une valeur d'une fonction.

Valeurs énumérées
ValueUnknown	Type de la valeur inconnu.
ValueReal	Valeur de type réelle.
ValueInteger	Valeur de type entière.
ValueBool	Valeur de type entière.
ValueString	Valeur de type chaîne de caractères.
ValueReal3	Valeur de type 'Real3'.

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

Documentation des fonctions membres

◆ checkIfValid()

virtual bool Arcane::ICaseFunction::checkIfValid ( ) const

pure virtual

Vérifie la validité de la fonction.

Valeurs retournées

true	si la fonction est valide,
false	sinon.

Implémenté dans Arcane::CaseTable, et Arcane::CaseFunction.

◆ deltatCoef()

virtual Real Arcane::ICaseFunction::deltatCoef ( ) const

pure virtual

Valeur du coefficient multiplicateur du deltat.

Implémenté dans Arcane::CaseFunction.

◆ name()

virtual String Arcane::ICaseFunction::name ( ) const

pure virtual

nom de la fonction

Implémenté dans Arcane::CaseFunction.

◆ paramType()

virtual eParamType Arcane::ICaseFunction::paramType ( ) const

pure virtual

Type du paramètre de la fonction.

Implémenté dans Arcane::CaseFunction.

◆ setDeltatCoef()

virtual void Arcane::ICaseFunction::setDeltatCoef ( Real v )

pure virtual

Positionne la Valeur du coefficient multiplicateur du deltat.

Ce coefficient, 0.0 par défaut est utilisé pour les fonctions qui prennent en paramètre le temps physique. Dans ce cas, la fonction utilise comme paramètre le temps courant global auquel est ajouté le pas de temps courant global multiplié par ce coefficient.

Implémenté dans Arcane::CaseFunction.

◆ setName()

virtual void Arcane::ICaseFunction::setName ( const String & new_name )

pure virtual

Positionne le nom de la fonction en new_name.

Implémenté dans Arcane::CaseFunction.

◆ setParamType()

virtual void Arcane::ICaseFunction::setParamType ( eParamType type )

pure virtual

Positionne le type de paramètre de la fonction.

Implémenté dans Arcane::CaseTable, et Arcane::CaseFunction.

◆ setTransformParamFunction()

virtual void Arcane::ICaseFunction::setTransformParamFunction ( const String & str )

pure virtual

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.

Implémenté dans Arcane::CaseFunction.

◆ setTransformValueFunction()

virtual void Arcane::ICaseFunction::setTransformValueFunction ( const String & str )

pure virtual

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.

Implémenté dans Arcane::CaseFunction.