Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::CaseFunction2 Class Referenceabstract

Public Member Functions

 CaseFunction2 (const CaseFunctionBuildInfo &cfbi)
 Constructs a data set function.
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
Public Member Functions inherited from Arcane::CaseFunction
 CaseFunction (const CaseFunctionBuildInfo &info)
 Constructs a dataset function.
String name () const override
 function name
void setName (const String &new_name) override
 Sets the function name to new_name.
eParamType paramType () const override
 Function parameter type.
void setParamType (eParamType type) override
 Sets the function parameter type.
eValueType valueType () const override
 Function value type.
void setValueType (eValueType type) override
 Sets the function value type.
void setTransformValueFunction (const String &str) override
 Sets a value transformation function. For now, this is just a multiplicative coefficient. The string str must be convertible to the value type.
String transformValueFunction () const override
 Returns the value transformation function.
void setTransformParamFunction (const String &str) override
 Sets a parameter transformation function. For now, this is just a multiplicative coefficient. It is only applied to real parameters. The string str must be convertible to a real number.
String transformParamFunction () const override
 Parameter transformation function.
void setDeltatCoef (Real v) override
 Sets the value of the deltat multiplier coefficient.
Real deltatCoef () const override
 Value of the deltat multiplier coefficient.
bool checkIfValid () const override
 Checks the validity of the function.
Ref< ICaseFunctiontoReference ()
ITraceMngtraceMng () const
Public Member Functions inherited from Arcane::ICaseFunction
virtual ~ICaseFunction ()=default
 Releases resources.
Public Member Functions inherited from Arcane::ReferenceCounterImpl
void addReference ()
void removeReference ()
void _internalAddReference ()
bool _internalRemoveReference ()

Protected Member Functions

void value (Real param, Real &v) const override
 Value v of the option for parameter param.
void value (Real param, Integer &v) const override
 Value v of the option for parameter param.
void value (Real param, bool &v) const override
 Value v of the option for parameter param.
void value (Real param, String &v) const override
 Value v of the option for parameter param.
void value (Real param, Real3 &v) const override
 Value v of the option for parameter param.
void value (Integer param, Real &v) const override
 Value v of the option for parameter param.
void value (Integer param, Integer &v) const override
 Value v of the option for parameter param.
void value (Integer param, bool &v) const override
void value (Integer param, String &v) const override
 Value v of the option for parameter param.
void value (Integer param, Real3 &v) const override
 Value v of the option for parameter param.
Protected Member Functions inherited from 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

Additional Inherited Members

Public Types inherited from Arcane::ICaseFunction
enum  eParamType { ParamUnknown = 0 , ParamReal = 1 , ParamInteger = 2 }
 Type of a function parameter. More...
enum  eValueType {
  ValueUnknown = 0 , ValueReal = 1 , ValueInteger = 2 , ValueBool = 3 ,
  ValueString = 4 , ValueReal3 = 5
}
 Type of a function value. More...

Detailed Description

Definition at line 41 of file CaseFunction2.h.

Constructor & Destructor Documentation

◆ CaseFunction2()

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

Constructs a data set function.

Definition at line 47 of file CaseFunction2.h.

References Arcane::CaseFunction::CaseFunction().

Member Function Documentation

◆ value() [1/10]

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

Implements Arcane::ICaseFunction.

Definition at line 81 of file CaseFunction2.h.

◆ value() [2/10]

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

Value v of the option for parameter param.

Implements Arcane::ICaseFunction.

Definition at line 77 of file CaseFunction2.h.

◆ value() [3/10]

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

Value v of the option for parameter param.

Implements Arcane::ICaseFunction.

Definition at line 73 of file CaseFunction2.h.

◆ value() [4/10]

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

Value v of the option for parameter param.

Implements Arcane::ICaseFunction.

Definition at line 89 of file CaseFunction2.h.

◆ value() [5/10]

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

Value v of the option for parameter param.

Implements Arcane::ICaseFunction.

Definition at line 85 of file CaseFunction2.h.

◆ value() [6/10]

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

Value v of the option for parameter param.

Implements Arcane::ICaseFunction.

Definition at line 61 of file CaseFunction2.h.

◆ value() [7/10]

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

Value v of the option for parameter param.

Implements Arcane::ICaseFunction.

Definition at line 57 of file CaseFunction2.h.

◆ value() [8/10]

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

Value v of the option for parameter param.

Implements Arcane::ICaseFunction.

Definition at line 53 of file CaseFunction2.h.

◆ value() [9/10]

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

Value v of the option for parameter param.

Implements Arcane::ICaseFunction.

Definition at line 69 of file CaseFunction2.h.

◆ value() [10/10]

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

Value v of the option for parameter param.

Implements Arcane::ICaseFunction.

Definition at line 65 of file CaseFunction2.h.


The documentation for this class was generated from the following file: