HostSInputRegular Class Reference

Inheritance diagram for HostSInputRegular:

Collaboration diagram for HostSInputRegular:

Public Member Functions
	HostSInputRegular (TiXmlElement *parms)
	The constructor for HostSInputRegular.
virtual void	init ()
	Initialize data.
virtual void	term ()
	Terminate process.
virtual void	inputStimulus ()
	Process input stimulus for each time step.
Public Member Functions inherited from SInputRegular
	SInputRegular (TiXmlElement *parms)
	The constructor for SInputRegular.
Public Member Functions inherited from ISInput

Additional Inherited Members
Protected Attributes inherited from SInputRegular
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 17 of file HostSInputRegular.h.

Constructor & Destructor Documentation

HostSInputRegular()

HostSInputRegular::HostSInputRegular

(

TiXmlElement *

parms

)

The constructor for HostSInputRegular.

constructor

Parameters

[in]	psi	Pointer to the simulation information
[in]	parms	TiXmlElement to examine.

Definition at line 15 of file HostSInputRegular.cpp.

Member Function Documentation

init()

void HostSInputRegular::init ( )

virtual

Initialize data.

Initialize data.

Parameters

[in]

psi

Pointer to the simulation information.

Reimplemented from SInputRegular.

Definition at line 22 of file HostSInputRegular.cpp.

inputStimulus()

void HostSInputRegular::inputStimulus ( )

virtual

Process input stimulus for each time step.

Process input stimulus for each time step. Apply inputs on summationPoint.

Parameters

[in]

psi

Pointer to the simulation information.

Implements ISInput.

Definition at line 38 of file HostSInputRegular.cpp.

term()

void HostSInputRegular::term ( )

virtual

Terminate process.

Terminate process.

Parameters

[in]

psi

Pointer to the simulation information.

Reimplemented from SInputRegular.

Definition at line 30 of file HostSInputRegular.cpp.

---

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

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