SInputRegular Class Reference

Inheritance diagram for SInputRegular:

Collaboration diagram for SInputRegular:

Public Member Functions
	SInputRegular (TiXmlElement *parms)
	The constructor for SInputRegular.
virtual void	init ()
	Initialize data.
virtual void	term ()
	Terminate process.
Public Member Functions inherited from ISInput
virtual void	inputStimulus ()=0

Protected Attributes
bool	fSInput
	True if stimuls input is on.
BGFLOAT	duration
	Duration of a pulse in second.
BGFLOAT	interval
	Interval between pulses in second.
int	nStepsCycle
	The number of time steps for one cycle of a stimulation.
int	nStepsInCycle
	The time step within a cycle of stimulation.
int	nStepsDuration
	The number of time steps for duration of a pulse.
int	nStepsInterval
	The number of time steps for interval between pulses.
vector< BGFLOAT >	initValues
	Initial input values.
vector< BGFLOAT >	values
	Input values, where each entry corresponds with a summationPoint.
vector< int >	nShiftValues
	Shift values, which determin the synch of stimuli (all 0 when synchronous)

Detailed Description

Definition at line 20 of file SInputRegular.h.

Constructor & Destructor Documentation

SInputRegular()

SInputRegular::SInputRegular

(

TiXmlElement *

parms

)

The constructor for SInputRegular.

constructor

Parameters

[in]	psi	Pointer to the simulation information
[in]	parms	Pointer to xml parms element

Definition at line 20 of file SInputRegular.cpp.

Member Function Documentation

init()

void SInputRegular::init ( )

virtual

Initialize data.

Initialize data.

Parameters

[in]

psi

Pointer to the simulation information.

Implements ISInput.

Reimplemented in GpuSInputRegular, and HostSInputRegular.

Definition at line 103 of file SInputRegular.cpp.

term()

void SInputRegular::term ( )

virtual

Terminate process.

Terminate process.

Parameters

[in]

psi

Pointer to the simulation information.

Implements ISInput.

Reimplemented in GpuSInputRegular, and HostSInputRegular.

Definition at line 110 of file SInputRegular.cpp.

Member Data Documentation

duration

BGFLOAT SInputRegular::duration

protected

Duration of a pulse in second.

Definition at line 38 of file SInputRegular.h.

fSInput

bool SInputRegular::fSInput

protected

True if stimuls input is on.

Definition at line 35 of file SInputRegular.h.

initValues

vector<BGFLOAT> SInputRegular::initValues

protected

Initial input values.

Definition at line 56 of file SInputRegular.h.

interval

BGFLOAT SInputRegular::interval

protected

Interval between pulses in second.

Definition at line 41 of file SInputRegular.h.

nShiftValues

vector<int> SInputRegular::nShiftValues

protected

Shift values, which determin the synch of stimuli (all 0 when synchronous)

Definition at line 62 of file SInputRegular.h.

nStepsCycle

int SInputRegular::nStepsCycle

protected

The number of time steps for one cycle of a stimulation.

Definition at line 44 of file SInputRegular.h.

nStepsDuration

int SInputRegular::nStepsDuration

protected

The number of time steps for duration of a pulse.

Definition at line 50 of file SInputRegular.h.

nStepsInCycle

int SInputRegular::nStepsInCycle

protected

The time step within a cycle of stimulation.

Definition at line 47 of file SInputRegular.h.

nStepsInterval

int SInputRegular::nStepsInterval

protected

The number of time steps for interval between pulses.

Definition at line 53 of file SInputRegular.h.

values

vector<BGFLOAT> SInputRegular::values

protected

Input values, where each entry corresponds with a summationPoint.

Definition at line 59 of file SInputRegular.h.

---

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

• Simulator/Utils/Inputs/SInputRegular.h
• Simulator/Utils/Inputs/SInputRegular.cpp