CEPS  24.01
Cardiac ElectroPhysiology Simulator
FctPiecewiseSAFunc< _Result > Class Template Reference

Detailed Description

template<typename _Result>
class FctPiecewiseSAFunc< _Result >

================================================================================================ Functions defined by region, or by unknown (piecewise), with functional pieces

Functions with result that very depending on the region attribute.

The stored function must be done with pointers.

Template Parameters
_ResultThe result type of the stored object

Definition at line 98 of file PiecewiseSAFunc.hpp.

#include <PiecewiseSAFunc.hpp>

Inheritance diagram for FctPiecewiseSAFunc< _Result >:
[legend]

Public Member Functions

 FctPiecewiseSAFunc (const CepsMap< CepsAttribute, SAFunc< _Result > * > &map)
 Constructor with map. More...
 
 FctPiecewiseSAFunc (const FctPiecewiseSAFunc &)=default
 We allow the copy from a functor to another. More...
 
FctPiecewiseSAFuncoperator= (const FctPiecewiseSAFunc &)=default
 We allow the assignement from a functor to another. More...
 
_Result eval (CepsStandardArgs args) final
 Call operator to evaluate functor. More...
 
CepsEnum getFlags () const final
 The final flag is a combination of Attribute and of the flags of the stored object type (if it has any) More...
 
- Public Member Functions inherited from SAFunc< _Result >
 SAFunc (const SAFunc &)=default
 We allow the copy from a functor to another. More...
 
SAFuncoperator= (const SAFunc &)=default
 We allow the assignement from a functor to another. More...
 
virtual void getLocalData ()
 Authorize access to data for solvecSAFunc, other derived classes : nothing. More...
 
virtual void releaseLocalData ()
 Authorize access to data for solvecSAFunc, other derived classes : nothing. More...
 
CepsBool hasOption (CepsFunctionFlag flag)
 Tells if option is activated. More...
 

Protected Attributes

CepsMap< CepsAttribute, SAFunc< _Result > * > m_map
 The mapping between regions and values (functional) More...
 

Additional Inherited Members

- Public Types inherited from SAFunc< _Result >
using BaseFunction = ceps::Function< _Result(CepsStandardArgs)>
 Typedef for the function type. More...
 

Constructor & Destructor Documentation

◆ FctPiecewiseSAFunc() [1/2]

template<typename _Result >
FctPiecewiseSAFunc< _Result >::FctPiecewiseSAFunc ( const CepsMap< CepsAttribute, SAFunc< _Result > * > &  map)
explicit

Constructor with map.

◆ FctPiecewiseSAFunc() [2/2]

template<typename _Result >
FctPiecewiseSAFunc< _Result >::FctPiecewiseSAFunc ( const FctPiecewiseSAFunc< _Result > &  )
default

We allow the copy from a functor to another.

Member Function Documentation

◆ eval()

template<typename _Result >
_Result FctPiecewiseSAFunc< _Result >::eval ( CepsStandardArgs  args)
final

Call operator to evaluate functor.

◆ getFlags()

template<typename _Result >
CepsEnum FctPiecewiseSAFunc< _Result >::getFlags ( ) const
finalvirtual

The final flag is a combination of Attribute and of the flags of the stored object type (if it has any)

Implements SAFunc< _Result >.

◆ operator=()

template<typename _Result >
FctPiecewiseSAFunc& FctPiecewiseSAFunc< _Result >::operator= ( const FctPiecewiseSAFunc< _Result > &  )
default

We allow the assignement from a functor to another.

Field Documentation

◆ m_map

template<typename _Result >
CepsMap<CepsAttribute,SAFunc<_Result>*> FctPiecewiseSAFunc< _Result >::m_map
protected

The mapping between regions and values (functional)

Definition at line 122 of file PiecewiseSAFunc.hpp.


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