ConnObjectValueGenerator Class Reference

Customizable generator for connecting SimObject (synapses) field values. More...

#include <ConnObjectValueGenerator.h>

Inheritance diagram for ConnObjectValueGenerator:

[legend]

List of all members.

Public Member Functions
	ConnObjectValueGenerator ()
virtual	~ConnObjectValueGenerator ()
virtual void	init (const SimObjectPopulation &src_pop, const SimObjectPopulation &dst_pop, RandomEngine *rnd=NULL)=0
	This function will be called to tell the value generator abut the populations.
virtual double	generate (size_t src_idx, size_t dst_idx, RandomEngine *rnd)=0
	This function will be called to actually generate the value.
virtual ConnObjectValueGenerator *	clone (void) const =0

---

Detailed Description

Customizable generator for connecting SimObject (synapses) field values.

Definition at line 19 of file ConnObjectValueGenerator.h.

---

Constructor & Destructor Documentation

ConnObjectValueGenerator::ConnObjectValueGenerator

(

)

Definition at line 14 of file ConnObjectValueGenerator.cpp.

ConnObjectValueGenerator::~ConnObjectValueGenerator

(

)

[virtual]

Definition at line 19 of file ConnObjectValueGenerator.cpp.

---

Member Function Documentation

virtual void ConnObjectValueGenerator::init	(	const SimObjectPopulation &	src_pop,
		const SimObjectPopulation &	dst_pop,
		RandomEngine *	rnd = NULL
	)			[pure virtual]

This function will be called to tell the value generator abut the populations.

An implementation of this function will check the actual type of the populations and stores references to the population. which will be used later on in the implementation of generate since this function just gets the indices within the population.

Implemented in ConnObjectValueGeneratorSpecialization< S, D >, ConnObjectValueGeneratorSpecialization< SimObjectPopulation, SimObjectPopulation >, ConnObjectValueGeneratorSpecialization< SpatialSimObjectPopulation, SpatialSimObjectPopulation >, ConnObjectValueGeneratorSpecialization< SpatialFamilyPopulation, SpatialFamilyPopulation >, and ConnObjectValueGeneratorSpecialization< AugmentedSpatialPopulation, AugmentedSpatialPopulation >.

virtual double ConnObjectValueGenerator::generate	(	size_t	src_idx,
		size_t	dst_idx,
		RandomEngine *	rnd
	)			[pure virtual]

This function will be called to actually generate the value.

Parameters:

	src_idx
	dst_idx
	rnd	Since only the indices into the source and destination populations are provided the method prepare has to store references to them.

Implemented in ConnObjectValueGeneratorSpecialization< S, D >, DelayCond, DelayCondAndSyn, LateralDelayCondAndSyn, ConnObjectValueGeneratorSpecialization< SimObjectPopulation, SimObjectPopulation >, ConnObjectValueGeneratorSpecialization< SpatialSimObjectPopulation, SpatialSimObjectPopulation >, ConnObjectValueGeneratorSpecialization< SpatialFamilyPopulation, SpatialFamilyPopulation >, and ConnObjectValueGeneratorSpecialization< AugmentedSpatialPopulation, AugmentedSpatialPopulation >.

virtual ConnObjectValueGenerator* ConnObjectValueGenerator::clone

(

void

)

const [pure virtual]

Implemented in DelayCond, DelayCondAndSyn, and LateralDelayCondAndSyn.

Referenced by ConnObjectFactory::set().

---

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

• /home/tnatschl/PCSIM-Sandbox/pcsim/pcsim/construction/ConnObjectValueGenerator.h
• /home/tnatschl/PCSIM-Sandbox/pcsim/pcsim/construction/ConnObjectValueGenerator.cpp