Arcane  v3.14.10.0
Documentation développeur
Chargement...
Recherche...
Aucune correspondance
Référence de la classe Arcane::StandardCaseFunction

Classe gérant une fonction standard du jeu de données. Plus de détails...

#include <arcane/core/StandardCaseFunction.h>

+ Graphe d'héritage de Arcane::StandardCaseFunction:
+ Graphe de collaboration de Arcane::StandardCaseFunction:

Fonctions membres publiques

 StandardCaseFunction (const CaseFunctionBuildInfo &info)
 Construit une fonction du jeu de données.
 
virtual IBinaryMathFunctor< Real, Real, Real > * getFunctorRealRealToReal ()
 
virtual IBinaryMathFunctor< Real, Real3, Real > * getFunctorRealReal3ToReal ()
 
virtual IBinaryMathFunctor< Real, Real, Real3 > * getFunctorRealRealToReal3 ()
 
virtual IBinaryMathFunctor< Real, Real3, Real3 > * getFunctorRealReal3ToReal3 ()
 
- 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.
 
void setParamType (eParamType type) override
 Positionne le type de 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.
 
bool checkIfValid () const override
 Vérifie la validité de la fonction.
 
Ref< ICaseFunctiontoReference ()
 
ITraceMngtraceMng () 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 ()
 

Fonctions membres privées

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

- 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 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

Classe gérant une fonction standard du jeu de données.

Cette classe doit être héritée et la classe dérivée doit surcharger l'une des méthodes qui renvoit un IFunctionWithArgAndReturn2. Sans surchage, toutes ces méthode retournent un pointeur nul. La classe dérivée n'est pas obligée de surchager toutes les méthodes getFunctor* mais peut se contenter de surcharger que ceux qu'elle souhaite.

Définition à la ligne 39 du fichier StandardCaseFunction.h.

Documentation des constructeurs et destructeur

◆ StandardCaseFunction()

Arcane::StandardCaseFunction::StandardCaseFunction ( const CaseFunctionBuildInfo info)

Construit une fonction du jeu de données.

Définition à la ligne 29 du fichier StandardCaseFunction.cc.

◆ ~StandardCaseFunction()

Arcane::StandardCaseFunction::~StandardCaseFunction ( )
virtual

Définition à la ligne 38 du fichier StandardCaseFunction.cc.

Documentation des fonctions membres

◆ getFunctorRealReal3ToReal()

IBinaryMathFunctor< Real, Real3, Real > * Arcane::StandardCaseFunction::getFunctorRealReal3ToReal ( )
virtual

Implémente Arcane::IStandardFunction.

Définition à la ligne 165 du fichier StandardCaseFunction.cc.

◆ getFunctorRealReal3ToReal3()

IBinaryMathFunctor< Real, Real3, Real3 > * Arcane::StandardCaseFunction::getFunctorRealReal3ToReal3 ( )
virtual

Implémente Arcane::IStandardFunction.

Définition à la ligne 183 du fichier StandardCaseFunction.cc.

◆ getFunctorRealRealToReal()

IBinaryMathFunctor< Real, Real, Real > * Arcane::StandardCaseFunction::getFunctorRealRealToReal ( )
virtual

Implémente Arcane::IStandardFunction.

Définition à la ligne 156 du fichier StandardCaseFunction.cc.

◆ getFunctorRealRealToReal3()

IBinaryMathFunctor< Real, Real, Real3 > * Arcane::StandardCaseFunction::getFunctorRealRealToReal3 ( )
virtual

Implémente Arcane::IStandardFunction.

Définition à la ligne 174 du fichier StandardCaseFunction.cc.

◆ value() [1/10]

void Arcane::StandardCaseFunction::value ( Integer  param,
bool v 
) const
privatevirtual

Implémente Arcane::ICaseFunction.

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

◆ value() [2/10]

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

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

Implémente Arcane::ICaseFunction.

Définition à la ligne 112 du fichier StandardCaseFunction.cc.

◆ value() [3/10]

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

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

Implémente Arcane::ICaseFunction.

Définition à la ligne 101 du fichier StandardCaseFunction.cc.

◆ value() [4/10]

void Arcane::StandardCaseFunction::value ( Integer  param,
Real3 v 
) const
privatevirtual

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

Implémente Arcane::ICaseFunction.

Définition à la ligne 145 du fichier StandardCaseFunction.cc.

◆ value() [5/10]

void Arcane::StandardCaseFunction::value ( Integer  param,
String v 
) const
privatevirtual

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

Implémente Arcane::ICaseFunction.

Définition à la ligne 134 du fichier StandardCaseFunction.cc.

◆ value() [6/10]

void Arcane::StandardCaseFunction::value ( Real  param,
bool v 
) const
privatevirtual

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

Implémente Arcane::ICaseFunction.

Définition à la ligne 68 du fichier StandardCaseFunction.cc.

◆ value() [7/10]

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

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

Implémente Arcane::ICaseFunction.

Définition à la ligne 57 du fichier StandardCaseFunction.cc.

◆ value() [8/10]

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

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

Implémente Arcane::ICaseFunction.

Définition à la ligne 46 du fichier StandardCaseFunction.cc.

◆ value() [9/10]

void Arcane::StandardCaseFunction::value ( Real  param,
Real3 v 
) const
privatevirtual

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

Implémente Arcane::ICaseFunction.

Définition à la ligne 90 du fichier StandardCaseFunction.cc.

◆ value() [10/10]

void Arcane::StandardCaseFunction::value ( Real  param,
String v 
) const
privatevirtual

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

Implémente Arcane::ICaseFunction.

Définition à la ligne 79 du fichier StandardCaseFunction.cc.


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