nest::spike_train_injector::Parameters_ Struct Reference

Independent parameters of the model. More...

Public Member Functions
	Parameters_ ()
	Sets default parameter values.
	Parameters_ (const Parameters_ &)=default
Parameters_ &	operator= (const Parameters_ &)=default
void	get (Dictionary &) const
	Store current values in dictionary.
void	set (const Dictionary &, State_ &, const Time &, const Time &, Node *node)
	Set values from dictionary.
void	assert_valid_spike_time_and_insert_ (double, const Time &, const Time &)
	Insert spike time to arrays, throw BadProperty for invalid spike times.

Public Attributes
std::vector< Time >	spike_stamps_
	Spike time stamp as Time, rel to origin_.
std::vector< double >	spike_offsets_
	Spike time offset, if using precise_times_.
std::vector< long >	spike_multiplicities_
	Spike multiplicity.
bool	precise_times_
	Interpret spike times as precise, i.e. send as step and offset.
bool	allow_offgrid_times_
	Allow and round up spikes not on steps; irrelevant if precise_times_.
bool	shift_now_spikes_
	Shift spike times at present to next step.

Detailed Description

Independent parameters of the model.

Constructor & Destructor Documentation

Parameters_() [1/2]

nest::spike_train_injector::Parameters_::Parameters_

(

)

Sets default parameter values.

Parameters_() [2/2]

nest::spike_train_injector::Parameters_::Parameters_ ( const Parameters_ &  )

default

Member Function Documentation

assert_valid_spike_time_and_insert_()

void nest::spike_train_injector::Parameters_::assert_valid_spike_time_and_insert_	(	double	t,
		const Time &	origin,
		const Time &	now
	)

Insert spike time to arrays, throw BadProperty for invalid spike times.

Parameters

spike	time, ms
origin
current	simulation time

get()

void nest::spike_train_injector::Parameters_::get

(

Dictionary &

d

)

const

Store current values in dictionary.

References nest::names::allow_offgrid_times(), nest::names::precise_times(), nest::names::shift_now_spikes(), nest::names::spike_multiplicities(), and nest::names::spike_times().

Referenced by nest::spike_train_injector::get_status().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

Parameters_ & nest::spike_train_injector::Parameters_::operator= ( const Parameters_ &  )

default

set()

void nest::spike_train_injector::Parameters_::set	(	const Dictionary &	d,
		State_ &	s,
		const Time &	origin,
		const Time &	now,
		Node *	node
	)

Set values from dictionary.

Note

State is passed so that the position can be reset if the spike_times_ vector has been filled with new data, or if the origin was reset.

References nest::names::allow_offgrid_times(), nest::names::origin(), nest::spike_train_injector::State_::position_, nest::names::precise_times(), nest::names::shift_now_spikes(), nest::names::spike_multiplicities(), nest::names::spike_times(), and nest::update_value_param().

Referenced by nest::spike_train_injector::set_status().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

allow_offgrid_times_

bool nest::spike_train_injector::Parameters_::allow_offgrid_times_

Allow and round up spikes not on steps; irrelevant if precise_times_.

precise_times_

bool nest::spike_train_injector::Parameters_::precise_times_

Interpret spike times as precise, i.e. send as step and offset.

Referenced by nest::spike_train_injector::is_off_grid(), and nest::spike_train_injector::update().

shift_now_spikes_

bool nest::spike_train_injector::Parameters_::shift_now_spikes_

Shift spike times at present to next step.

spike_multiplicities_

std::vector< long > nest::spike_train_injector::Parameters_::spike_multiplicities_

Spike multiplicity.

Referenced by nest::spike_train_injector::update().

spike_offsets_

std::vector< double > nest::spike_train_injector::Parameters_::spike_offsets_

Spike time offset, if using precise_times_.

Referenced by nest::spike_train_injector::update().

spike_stamps_

std::vector< Time > nest::spike_train_injector::Parameters_::spike_stamps_

Spike time stamp as Time, rel to origin_.

Referenced by nest::spike_train_injector::update().

---

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

• spike_train_injector.h
• spike_train_injector.cpp