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

Implémentation de CaseFunction permettant de retourner directement la valeur associée à un paramètre sans passer par une référence. Plus de détails...

#include <arcane/core/CaseFunction2.h>

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

Fonctions membres publiques

 CaseFunction2 (const CaseFunctionBuildInfo &cfbi)
 Construit une fonction du jeu de données.
 
virtual Real valueAsReal (Real param) const =0
 
virtual Integer valueAsInteger (Real param) const =0
 
virtual bool valueAsBool (Real param) const =0
 
virtual String valueAsString (Real param) const =0
 
virtual Real3 valueAsReal3 (Real param) const =0
 
virtual Real valueAsReal (Integer param) const =0
 
virtual Integer valueAsInteger (Integer param) const =0
 
virtual bool valueAsBool (Integer param) const =0
 
virtual String valueAsString (Integer param) const =0
 
virtual Real3 valueAsReal3 (Integer param) const =0
 
- 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 protégées

void value (Real param, Real &v) const override
 Valeur v de l'option pour le paramètre param.
 
void value (Real param, Integer &v) const override
 Valeur v de l'option pour le paramètre param.
 
void value (Real param, bool &v) const override
 Valeur v de l'option pour le paramètre param.
 
void value (Real param, String &v) const override
 Valeur v de l'option pour le paramètre param.
 
void value (Real param, Real3 &v) const override
 Valeur v de l'option pour le paramètre param.
 
void value (Integer param, Real &v) const override
 Valeur v de l'option pour le paramètre param.
 
void value (Integer param, Integer &v) const override
 Valeur v de l'option pour le paramètre param.
 
void value (Integer param, bool &v) const override
 
void value (Integer param, String &v) const override
 Valeur v de l'option pour le paramètre param.
 
void value (Integer param, Real3 &v) const override
 Valeur v de l'option pour le paramètre param.
 
- 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
 

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

Description détaillée

Implémentation de CaseFunction permettant de retourner directement la valeur associée à un paramètre sans passer par une référence.

Cela est principalement utilisé pour simplifier les extensions C# en évitant les différentes surcharges de value().

Pour utiliser cette classe, il faut implémenter les méthodes 'valueAs*' pour les deux types d'argument Integer et Real et pour les différents types de retour possibles.

Définition à la ligne 40 du fichier CaseFunction2.h.

Documentation des constructeurs et destructeur

◆ CaseFunction2()

Arcane::CaseFunction2::CaseFunction2 ( const CaseFunctionBuildInfo cfbi)
inlineexplicit

Construit une fonction du jeu de données.

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

Documentation des fonctions membres

◆ value() [1/10]

void Arcane::CaseFunction2::value ( Integer  param,
bool v 
) const
inlineoverrideprotectedvirtual

Implémente Arcane::ICaseFunction.

Définition à la ligne 80 du fichier CaseFunction2.h.

◆ value() [2/10]

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

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

Implémente Arcane::ICaseFunction.

Définition à la ligne 76 du fichier CaseFunction2.h.

◆ value() [3/10]

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

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

Implémente Arcane::ICaseFunction.

Définition à la ligne 72 du fichier CaseFunction2.h.

◆ value() [4/10]

void Arcane::CaseFunction2::value ( Integer  param,
Real3 v 
) const
inlineoverrideprotectedvirtual

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

Implémente Arcane::ICaseFunction.

Définition à la ligne 88 du fichier CaseFunction2.h.

◆ value() [5/10]

void Arcane::CaseFunction2::value ( Integer  param,
String v 
) const
inlineoverrideprotectedvirtual

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

Implémente Arcane::ICaseFunction.

Définition à la ligne 84 du fichier CaseFunction2.h.

◆ value() [6/10]

void Arcane::CaseFunction2::value ( Real  param,
bool v 
) const
inlineoverrideprotectedvirtual

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

Implémente Arcane::ICaseFunction.

Définition à la ligne 60 du fichier CaseFunction2.h.

◆ value() [7/10]

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

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

Implémente Arcane::ICaseFunction.

Définition à la ligne 56 du fichier CaseFunction2.h.

◆ value() [8/10]

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

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

Implémente Arcane::ICaseFunction.

Définition à la ligne 52 du fichier CaseFunction2.h.

◆ value() [9/10]

void Arcane::CaseFunction2::value ( Real  param,
Real3 v 
) const
inlineoverrideprotectedvirtual

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

Implémente Arcane::ICaseFunction.

Définition à la ligne 68 du fichier CaseFunction2.h.

◆ value() [10/10]

void Arcane::CaseFunction2::value ( Real  param,
String v 
) const
inlineoverrideprotectedvirtual

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

Implémente Arcane::ICaseFunction.

Définition à la ligne 64 du fichier CaseFunction2.h.


La documentation de cette classe a été générée à partir du fichier suivant :