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

#include <stimulate.h>

Collaboration diagram for opencarp::stim_protocol:

Public Member Functions

void setup (int idx, std::string name)
 Setup from a param stimulus index. More...
 

Public Attributes

double start = 0.0
 start time of protocol More...
 
int npls = 0
 number of stimulus pulses More...
 
double pcl = 0.0
 pacing cycle length More...
 
int timer_id = -1
 timer for stimulus More...
 
int xtrg_id = -1
 external trigger ID, not used for now More...
 

Detailed Description

Definition at line 115 of file stimulate.h.

Member Function Documentation

◆ setup()

void opencarp::stim_protocol::setup ( int  idx,
std::string  name 
)

Setup from a param stimulus index.

assign protocol parameters and generated timer

Parameters
idxThe index of the stimulus used for setup.
nameProtocol name

Definition at line 271 of file stimulate.cc.

Here is the caller graph for this function:

Member Data Documentation

◆ npls

int opencarp::stim_protocol::npls = 0

number of stimulus pulses

Definition at line 119 of file stimulate.h.

◆ pcl

double opencarp::stim_protocol::pcl = 0.0

pacing cycle length

Definition at line 120 of file stimulate.h.

◆ start

double opencarp::stim_protocol::start = 0.0

start time of protocol

Definition at line 118 of file stimulate.h.

◆ timer_id

int opencarp::stim_protocol::timer_id = -1

timer for stimulus

Definition at line 121 of file stimulate.h.

◆ xtrg_id

int opencarp::stim_protocol::xtrg_id = -1

external trigger ID, not used for now

Definition at line 122 of file stimulate.h.


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