openCARP
Doxygen code documentation for the open cardiac electrophysiology simulator openCARP
Public Member Functions | Public Attributes | List of all members
opencarp::stim_pulse Class Reference

define the wave form of a stimulation pulse More...

#include <stimulate.h>

Collaboration diagram for opencarp::stim_pulse:

Public Member Functions

void assign (double _strength, double _duration, double _dt, waveform_t _wform)
 
void setup (int id)
 Setup from a param stimulus index. More...
 

Public Attributes

double strength = 0.0
 strength of stimulus More...
 
double duration = 0.0
 duration of stimulus More...
 
waveform_t wform = unsetPulse
 wave form of stimulus More...
 
sig::time_trace wave
 wave form of stimulus pulse More...
 

Detailed Description

define the wave form of a stimulation pulse

Definition at line 95 of file stimulate.h.

Member Function Documentation

◆ assign()

void opencarp::stim_pulse::assign ( double  _strength,
double  _duration,
double  _dt,
waveform_t  _wform 
)
inline

Definition at line 104 of file stimulate.h.

◆ setup()

void opencarp::stim_pulse::setup ( int  id)

Setup from a param stimulus index.

define stimulus waveform and generate discrete trace of it

Parameters
idThe index of the stimulus used for setup.

Definition at line 199 of file stimulate.cc.

Here is the caller graph for this function:

Member Data Documentation

◆ duration

double opencarp::stim_pulse::duration = 0.0

duration of stimulus

Definition at line 99 of file stimulate.h.

◆ strength

double opencarp::stim_pulse::strength = 0.0

strength of stimulus

Definition at line 98 of file stimulate.h.

◆ wave

sig::time_trace opencarp::stim_pulse::wave

wave form of stimulus pulse

Definition at line 102 of file stimulate.h.

◆ wform

waveform_t opencarp::stim_pulse::wform = unsetPulse

wave form of stimulus

Definition at line 100 of file stimulate.h.


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