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

Detailed Description

template<typename _Result>
class CstPiecewiseSAFunc< _Result >

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

Functions with result that very depending on the region attribute.

Template Parameters
_ResultThe result type of the stored object
_ObjectThe type of stored object

Definition at line 43 of file PiecewiseSAFunc.hpp.

#include <PiecewiseSAFunc.hpp>

Inheritance diagram for CstPiecewiseSAFunc< _Result >:
[legend]

Public Member Functions

 CstPiecewiseSAFunc (const CepsMap< CepsAttribute, _Result > &map)
 Constructor with map. More...
 
 CstPiecewiseSAFunc (const CstPiecewiseSAFunc &)=default
 We allow the copy from a functor to another. More...
 
CstPiecewiseSAFuncoperator= (const CstPiecewiseSAFunc &)=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
 flag is Attribute only 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, _Result > m_map
 The mapping between regions and values. 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

◆ CstPiecewiseSAFunc() [1/2]

template<typename _Result >
CstPiecewiseSAFunc< _Result >::CstPiecewiseSAFunc ( const CepsMap< CepsAttribute, _Result > &  map)
explicit

Constructor with map.

◆ CstPiecewiseSAFunc() [2/2]

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

We allow the copy from a functor to another.

Member Function Documentation

◆ eval()

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

Call operator to evaluate functor.

◆ getFlags()

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

flag is Attribute only

Implements SAFunc< _Result >.

◆ operator=()

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

We allow the assignement from a functor to another.

Field Documentation

◆ m_map

template<typename _Result >
CepsMap<CepsAttribute,_Result> CstPiecewiseSAFunc< _Result >::m_map
protected

The mapping between regions and values.

Definition at line 69 of file PiecewiseSAFunc.hpp.


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