Parameters for a spatially homogeneous boost stimulus. More...

Inheritance diagram for dnf_composer::element::BoostStimulusParameters:

Collaboration diagram for dnf_composer::element::BoostStimulusParameters:

Public Member Functions
	BoostStimulusParameters (const double amplitude=5.0, const bool isActive=true)
	Construct a BoostStimulus parameter set.

bool	operator== (const BoostStimulusParameters &other) const

std::string	toString () const override

Public Member Functions inherited from dnf_composer::element::ElementSpecificParameters
	ElementSpecificParameters ()=default

void	print () const

virtual	~ElementSpecificParameters ()=default

Public Attributes
double	amplitude
	Uniform input value applied across the entire field.

bool	isActive
	If false, the stimulus outputs zero regardless of amplitude.

Detailed Description

Parameters for a spatially homogeneous boost stimulus.

Constructor & Destructor Documentation

dnf_composer::element::BoostStimulusParameters::BoostStimulusParameters	(	const double	amplitude = `5.0`,
		const bool	isActive = `true`
	)

inlineexplicit

Construct a BoostStimulus parameter set.

Parameters

amplitude	Homogeneous input amplitude (default 5.0).
isActive	Whether the stimulus is currently active (default true).

bool dnf_composer::element::BoostStimulusParameters::operator== ( const BoostStimulusParameters & other ) const

inline

std::string dnf_composer::element::BoostStimulusParameters::toString ( ) const

inlineoverridevirtual

Here is the caller graph for this function:

double dnf_composer::element::BoostStimulusParameters::amplitude

Uniform input value applied across the entire field.

bool dnf_composer::element::BoostStimulusParameters::isActive

If false, the stimulus outputs zero regardless of amplitude.

The documentation for this struct was generated from the following file: