opencarp::stimulus Class Reference

#include <stimulate.h>

Collaboration diagram for opencarp::stimulus:

Public Member Functions
void	setup (int idx)
	Setup from a param stimulus index. More...
void	translate (int id)
	convert legacy definitions to new format More...
bool	value (double &v) const
	Get the current value if the stimulus is active. More...
bool	is_active () const
	Return whether stim is active. More...

Public Attributes
int	idx = -1
	index in global input stimulus array More...
std::string	name = "unnamed"
	label stimulus More...
stim_pulse	pulse
	stimulus wave form More...
stim_protocol	ptcl
	applied stimulation protocol used More...
stim_physics	phys
	physics of stimulus More...
stim_electrode	electrode
	electrode geometry More...

Detailed Description

Definition at line 160 of file stimulate.h.

Member Function Documentation

is_active()

bool opencarp::stimulus::is_active

(

)

const

Return whether stim is active.

Definition at line 185 of file stimulate.cc.

setup()

void opencarp::stimulus::setup

(

int

iidx

)

Setup from a param stimulus index.

Parameters

id	The index of the stimulus used for setup.
iidx

Definition at line 161 of file stimulate.cc.

Here is the caller graph for this function:

translate()

void opencarp::stimulus::translate

(

int

id

)

convert legacy definitions to new format

map old stimulus definition to new structured definition

Definition at line 100 of file stimulate.cc.

Here is the caller graph for this function:

value()

bool opencarp::stimulus::value

(

double &

v

)

const

Get the current value if the stimulus is active.

Parameters

[out]

v

The current stimulus value.

Returns

True if the stimulus is active, false otherwise.

Definition at line 430 of file stimulate.cc.

Here is the caller graph for this function:

Member Data Documentation

electrode

stim_electrode opencarp::stimulus::electrode

electrode geometry

Definition at line 168 of file stimulate.h.

idx

int opencarp::stimulus::idx = -1

index in global input stimulus array

Definition at line 163 of file stimulate.h.

name

std::string opencarp::stimulus::name = "unnamed"

label stimulus

Definition at line 164 of file stimulate.h.

phys

stim_physics opencarp::stimulus::phys

physics of stimulus

Definition at line 167 of file stimulate.h.

ptcl

stim_protocol opencarp::stimulus::ptcl

applied stimulation protocol used

Definition at line 166 of file stimulate.h.

pulse

stim_pulse opencarp::stimulus::pulse

stimulus wave form

Definition at line 165 of file stimulate.h.

---

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

• physics/stimulate.h
• physics/stimulate.cc