Fonction du jeu de données. Plus de détails...

#include <arcane/core/CaseFunction.h>

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

Graphe de collaboration de Arcane::CaseFunction:

Fonctions membres publiques
	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< ICaseFunction >	toReference ()

ITraceMng *	traceMng () const

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

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 publiques hérités de Arccore::ReferenceCounterImpl
void	addReference ()

void	removeReference ()

void	_internalAddReference ()

bool	_internalRemoveReference ()

Fonctions membres protégées
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

Fonctions membres privées
	ARCCORE_DEFINE_REFERENCE_COUNTED_INCLASS_METHODS ()

Attributs privés
ITraceMng *	m_trace
	Gestionnaire de traces.

String	m_name
	Nom de la fonction.

eParamType	m_param_type
	Type du paramètre (x)

eValueType	m_value_type
	Type de la valeur (y)

String	m_transform_param_func
	Fonction de transformation du paramètre.

String	m_transform_value_func
	Fonction de transformation de la valeur.

Real	m_deltat_coef

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

Fonction du jeu de données.

Définition à la ligne 77 du fichier CaseFunction.h.

Documentation des constructeurs et destructeur

◆ CaseFunction()

Arcane::CaseFunction::CaseFunction ( const CaseFunctionBuildInfo & info )

explicit

Construit une fonction du jeu de données.

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

◆ ~CaseFunction()

Arcane::CaseFunction::~CaseFunction ( )

override

Définition à la ligne 60 du fichier CaseFunction.cc.

Documentation des fonctions membres

◆ _applyParamTransform() [1/2]

void Arcane::CaseFunction::_applyParamTransform ( Integer & value ) const

protected

Définition à la ligne 243 du fichier CaseFunction.cc.

◆ _applyParamTransform() [2/2]

void Arcane::CaseFunction::_applyParamTransform ( Real & value ) const

protected

Définition à la ligne 234 du fichier CaseFunction.cc.

◆ _applyParamTransform2()

template<typename ParamType >

void Arcane::CaseFunction::_applyParamTransform2 ( ParamType & param ) const

protected

Définition à la ligne 214 du fichier CaseFunction.cc.

◆ _applyValueComulTransform() [1/5]

bool Arcane::CaseFunction::_applyValueComulTransform	(	bool	v,
		bool	comul
	)		const

protected

Définition à la ligne 157 du fichier CaseFunction.cc.

◆ _applyValueComulTransform() [2/5]

String Arcane::CaseFunction::_applyValueComulTransform	(	const String &	v,
		const String &	comul
	)		const

protected

Définition à la ligne 150 du fichier CaseFunction.cc.

◆ _applyValueComulTransform() [3/5]

Integer Arcane::CaseFunction::_applyValueComulTransform	(	Integer	v,
		Integer	comul
	)		const

protected

Définition à la ligne 140 du fichier CaseFunction.cc.

◆ _applyValueComulTransform() [4/5]

Real Arcane::CaseFunction::_applyValueComulTransform	(	Real	v,
		Real	comul
	)		const

protected

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

◆ _applyValueComulTransform() [5/5]

Real3 Arcane::CaseFunction::_applyValueComulTransform	(	Real3	v,
		Real3	comul
	)		const

protected

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

◆ _applyValueTransform() [1/5]

void Arcane::CaseFunction::_applyValueTransform ( bool & value ) const

protected

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

◆ _applyValueTransform() [2/5]

void Arcane::CaseFunction::_applyValueTransform ( Integer & value ) const

protected

Définition à la ligne 195 du fichier CaseFunction.cc.

◆ _applyValueTransform() [3/5]

void Arcane::CaseFunction::_applyValueTransform ( Real & value ) const

protected

Définition à la ligne 185 du fichier CaseFunction.cc.

◆ _applyValueTransform() [4/5]

void Arcane::CaseFunction::_applyValueTransform ( Real3 & value ) const

protected

Définition à la ligne 190 du fichier CaseFunction.cc.

◆ _applyValueTransform() [5/5]

void Arcane::CaseFunction::_applyValueTransform ( String & value ) const

protected

Définition à la ligne 200 du fichier CaseFunction.cc.

◆ _applyValueTransform2()

template<typename ValueType >

void Arcane::CaseFunction::_applyValueTransform2 ( ValueType & value ) const

protected

Définition à la ligne 168 du fichier CaseFunction.cc.

◆ checkIfValid()

bool Arcane::CaseFunction::checkIfValid ( ) const

overridevirtual

Vérifie la validité de la fonction.

Valeurs retournées

true	si la fonction est valide,
false	sinon.

Implémente Arcane::ICaseFunction.

Réimplémentée dans Arcane::CaseTable.

Définition à la ligne 126 du fichier CaseFunction.cc.

◆ deltatCoef()

Real Arcane::CaseFunction::deltatCoef ( ) const

inlineoverridevirtual

Valeur du coefficient multiplicateur du deltat.

Implémente Arcane::ICaseFunction.

Définition à la ligne 107 du fichier CaseFunction.h.

◆ name()

String Arcane::CaseFunction::name ( ) const

inlineoverridevirtual

nom de la fonction

Implémente Arcane::ICaseFunction.

Définition à la ligne 91 du fichier CaseFunction.h.

Référencé par Arcane::CaseTable::_findValue().

◆ paramType()

eParamType Arcane::CaseFunction::paramType ( ) const

inlineoverridevirtual

Type du paramètre de la fonction.

Implémente Arcane::ICaseFunction.

Définition à la ligne 94 du fichier CaseFunction.h.

Référencé par Arcane::CaseTable::setParamType().

◆ setDeltatCoef()

void Arcane::CaseFunction::setDeltatCoef ( Real v )

inlineoverridevirtual

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émente Arcane::ICaseFunction.

Définition à la ligne 106 du fichier CaseFunction.h.

◆ setName()

void Arcane::CaseFunction::setName ( const String & new_name )

overridevirtual

Positionne le nom de la fonction en new_name.

Implémente Arcane::ICaseFunction.

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

Références m_name.

◆ setParamType()

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

overridevirtual

Positionne le type de paramètre de la fonction.

Implémente Arcane::ICaseFunction.

Réimplémentée dans Arcane::CaseTable.

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

Références m_param_type.

Référencé par Arcane::CaseTable::setParamType().

◆ setTransformParamFunction()

void Arcane::CaseFunction::setTransformParamFunction ( const String & str )

overridevirtual

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émente Arcane::ICaseFunction.

Définition à la ligne 117 du fichier CaseFunction.cc.

Références m_transform_param_func.

◆ setTransformValueFunction()

void Arcane::CaseFunction::setTransformValueFunction ( const String & str )

overridevirtual

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émente Arcane::ICaseFunction.

Définition à la ligne 108 du fichier CaseFunction.cc.

Références m_transform_value_func.

◆ setValueType()

void Arcane::CaseFunction::setValueType ( eValueType type )

overridevirtual

Positionne le type des valeurs de la fonction.

Implémente Arcane::ICaseFunction.

Définition à la ligne 93 du fichier CaseFunction.cc.

Références m_value_type.

◆ toReference()

Ref< ICaseFunction > Arcane::CaseFunction::toReference ( )

Définition à la ligne 252 du fichier CaseFunction.cc.

◆ traceMng()

ITraceMng * Arcane::CaseFunction::traceMng ( ) const

inline

Définition à la ligne 112 du fichier CaseFunction.h.

◆ transformParamFunction()

String Arcane::CaseFunction::transformParamFunction ( ) const

inlineoverridevirtual

Fonction de transformation du paramètre.

Implémente Arcane::ICaseFunction.

Définition à la ligne 104 du fichier CaseFunction.h.

◆ transformValueFunction()

String Arcane::CaseFunction::transformValueFunction ( ) const

inlineoverridevirtual

Retourne la fonction de transformation de la valeur.

Implémente Arcane::ICaseFunction.

Définition à la ligne 101 du fichier CaseFunction.h.

◆ valueType()

eValueType Arcane::CaseFunction::valueType ( ) const

inlineoverridevirtual

Type des valeurs de la fonction.

Implémente Arcane::ICaseFunction.

Définition à la ligne 97 du fichier CaseFunction.h.

Documentation des données membres

◆ m_deltat_coef

Real Arcane::CaseFunction::m_deltat_coef

private

Définition à la ligne 124 du fichier CaseFunction.h.

◆ m_name

String Arcane::CaseFunction::m_name

private

Nom de la fonction.

Définition à la ligne 119 du fichier CaseFunction.h.

Référencé par setName().

◆ m_param_type

eParamType Arcane::CaseFunction::m_param_type

private

Type du paramètre (x)

Définition à la ligne 120 du fichier CaseFunction.h.

Référencé par setParamType().

◆ m_trace

ITraceMng* Arcane::CaseFunction::m_trace

private

Gestionnaire de traces.

Définition à la ligne 118 du fichier CaseFunction.h.

◆ m_transform_param_func

String Arcane::CaseFunction::m_transform_param_func

private

Fonction de transformation du paramètre.

Définition à la ligne 122 du fichier CaseFunction.h.

Référencé par setTransformParamFunction().

◆ m_transform_value_func

String Arcane::CaseFunction::m_transform_value_func

private

Fonction de transformation de la valeur.

Définition à la ligne 123 du fichier CaseFunction.h.

Référencé par setTransformValueFunction().

◆ m_value_type

eValueType Arcane::CaseFunction::m_value_type

private

Type de la valeur (y)

Définition à la ligne 121 du fichier CaseFunction.h.

Référencé par setValueType().

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

Fonctions membres publiques

Fonctions membres protégées

Fonctions membres privées

Attributs privés

Membres hérités additionnels

Description détaillée

Documentation des constructeurs et destructeur

◆ CaseFunction()

◆ ~CaseFunction()

Documentation des fonctions membres

◆ _applyParamTransform() [1/2]

◆ _applyParamTransform() [2/2]

◆ _applyParamTransform2()

◆ _applyValueComulTransform() [1/5]

◆ _applyValueComulTransform() [2/5]

◆ _applyValueComulTransform() [3/5]

◆ _applyValueComulTransform() [4/5]

◆ _applyValueComulTransform() [5/5]

◆ _applyValueTransform() [1/5]

◆ _applyValueTransform() [2/5]

◆ _applyValueTransform() [3/5]

◆ _applyValueTransform() [4/5]

◆ _applyValueTransform() [5/5]

◆ _applyValueTransform2()

◆ checkIfValid()

◆ deltatCoef()

◆ name()

◆ paramType()

◆ setDeltatCoef()

◆ setName()

◆ setParamType()

◆ setTransformParamFunction()

◆ setTransformValueFunction()

◆ setValueType()

◆ toReference()

◆ traceMng()

◆ transformParamFunction()

◆ transformValueFunction()

◆ valueType()

Documentation des données membres

◆ m_deltat_coef

◆ m_name

◆ m_param_type

◆ m_trace

◆ m_transform_param_func

◆ m_transform_value_func

◆ m_value_type