OneToOneWiringMethod Class Reference

Simple implementation of WiringMethod which build a one-to-one connection between corresponding SimObject's in the SimObjectPopulation's. More...

#include <OneToOneWiringMethod.h>

Inheritance diagram for OneToOneWiringMethod:

[legend]

Collaboration diagram for OneToOneWiringMethod:

[legend]

List of all members.

Public Member Functions

OneToOneWiringMethod (SimNetwork *net)

New OneToOneWiringMethod which belongs to the given SimNetwork.

OneToOneWiringMethod (SimNetwork &net)

New OneToOneWiringMethod which belongs to the given SimNetwork.

virtual ~OneToOneWiringMethod ()

virtual unsigned connect (const SimObjectPopulation &source, const SimObjectPopulation &destination, ConnectionIterator &iterator, bool collectPairs=false, ConnectPairsVector connectPairs=ConnectPairsVector(new vector< pair< SimObject::ID, SimObject::ID > >))

Make direct connections between source and dest. population.

virtual SimObject::ID::Vector connect (const SimObjectPopulation &source, const SimObjectPopulation &destination, const SimObjectFactory &connector, ConnectionIterator &iterator, bool collectIDs=false, bool collectPairs=false, WiringMethod::ConnectPairsVector connectPairs=WiringMethod::ConnectPairsVector(new vector< pair< SimObject::ID, SimObject::ID > >))

Make connections between source and dest. population using a SimObjectFactory (usually some synapse) to connect the objects.

virtual SimObject::ID::Vector connect (const SimObjectPopulation &source, const SimObjectPopulation &destination, ConnObjectFactory &connector, ConnectionIterator &iterator, bool collectIDs=false, bool collectPairs=false, WiringMethod::ConnectPairsVector connectPairs=WiringMethod::ConnectPairsVector(new vector< pair< SimObject::ID, SimObject::ID > >))

Make connections between source and dest. population using a SimObjectFactory (usually some synapse) to connect the objects.

unsigned connect (const SimObjectPopulation &source, const SimObjectPopulation &destination, const Time &delay, bool collectPairs=false, WiringMethod::ConnectPairsVector connectPairs=WiringMethod::ConnectPairsVector(new vector< pair< SimObject::ID, SimObject::ID > >))

unsigned connect (const vector< SimObject::ID::Packed > &source, const vector< SimObject::ID::Packed > &destination, const Time &delay, bool collectPairs=false, ConnectPairsVector connectPairs=ConnectPairsVector(new vector< pair< SimObject::ID, SimObject::ID > >))

Detailed Description

Simple implementation of WiringMethod which build a one-to-one connection between corresponding SimObject's in the SimObjectPopulation's.

The correspondance is by index: The SimObject with index i in the source population is connected to the SimObject with index i in the destination population.

Definition at line 21 of file OneToOneWiringMethod.h.

Constructor & Destructor Documentation

OneToOneWiringMethod::OneToOneWiringMethod ( SimNetwork * net ) [inline]

New OneToOneWiringMethod which belongs to the given SimNetwork.

Definition at line 27 of file OneToOneWiringMethod.h.

OneToOneWiringMethod::OneToOneWiringMethod ( SimNetwork & net ) [inline]

New OneToOneWiringMethod which belongs to the given SimNetwork.

Definition at line 34 of file OneToOneWiringMethod.h.

virtual OneToOneWiringMethod::~OneToOneWiringMethod ( ) [inline, virtual]

Definition at line 40 of file OneToOneWiringMethod.h.

Member Function Documentation

unsigned OneToOneWiringMethod::connect	(	const SimObjectPopulation &	source,
		const SimObjectPopulation &	destination,
		ConnectionIterator &	iterator,
		bool	collectPairs = `false`,
		ConnectPairsVector	connectPairs = `ConnectPairsVector(new vector< pair< SimObject::ID, SimObject::ID > >)`
	)			`[virtual]`

Make direct connections between source and dest. population.

Parameters:

	source	The source population
	destination	The destination population (can be the same as source population)
	iterator	The connection iterator to use (e.g. PredicateBasedConnections or RandomConnections ) which determines which connections are made.
	collectPairs	Flaf which idicates wheter the pairs of ID's of the connected objects souble be collected or not.
	connectPairs	Vector where the collected connection pairs are written to if collectPairs == true Be aware that the collected pairs are collected on each node of a distributed simulation when using a DistributedSingleThreadNetwork or DistributedMultiThreadNetwork which may lead to a large memory consumption.

Implements WiringMethod.

Definition at line 66 of file OneToOneWiringMethod.cpp.

References SimNetwork::connect(), WiringMethod::net, and SimObjectPopulation::size().

Referenced by connect().

Here is the call graph for this function:

SimObject::ID::Vector OneToOneWiringMethod::connect	(	const SimObjectPopulation &	source,
		const SimObjectPopulation &	destination,
		const SimObjectFactory &	connector,
		ConnectionIterator &	iterator,
		bool	collectIDs = `false`,
		bool	collectPairs = `false`,
		WiringMethod::ConnectPairsVector	connectPairs = `WiringMethod::ConnectPairsVector(new vector< pair< SimObject::ID, SimObject::ID > >)`
	)			`[virtual]`

Make connections between source and dest. population using a SimObjectFactory (usually some synapse) to connect the objects.

Parameters:

	source	The source population
	destination	The destination population (can be the same as source population)
	connector	The SimObjectFactory to use to generate connecting objects (e.g. StaticSpikingSynapse)
	iterator	The connection iterator to use (e.g. PredicateBasedConnections or RandomConnections ) which determines which connections are made.
	collectIDs	Flag which idicates whether the SimObject::ID's of the generated connector objects should be collected or not.
	collectPairs	Flaf which idicates wheter the pairs of ID's of the connected objects souble be collected or not.
	connectPairs	Vector where the collected connection pairs are written to if collectPairs == true Be aware that the collected ID's or indices are collected on each node of a distributed simulation when using a DistributedSingleThreadNetwork or DistributedMultiThreadNetwork which may lead to a large memory consumption.

Implements WiringMethod.

Definition at line 22 of file OneToOneWiringMethod.cpp.

References SimNetwork::connect(), WiringMethod::net, and SimObjectPopulation::size().

Here is the call graph for this function:

SimObject::ID::Vector OneToOneWiringMethod::connect	(	const SimObjectPopulation &	source,
		const SimObjectPopulation &	destination,
		ConnObjectFactory &	connector,
		ConnectionIterator &	iterator,
		bool	collectIDs = `false`,
		bool	collectPairs = `false`,
		WiringMethod::ConnectPairsVector	connectPairs = `WiringMethod::ConnectPairsVector(new vector< pair< SimObject::ID, SimObject::ID > >)`
	)			`[virtual]`

Make connections between source and dest. population using a SimObjectFactory (usually some synapse) to connect the objects.

Parameters:

	source	The source population
	destination	The destination population (can be the same as source population)
	connector	The SimObjectFactory to use to generate connecting objects (e.g. StaticSpikingSynapse)
	iterator	The connection iterator to use (e.g. PredicateBasedConnections or RandomConnections ) which determines which connections are made.
	collectIDs	Flag which idicates whether the SimObject::ID's of the generated connector objects should be collected or not.
	collectPairs	Flaf which idicates wheter the pairs of ID's of the connected objects souble be collected or not.
	connectPairs	Vector where the collected connection pairs are written to if collectPairs == true Be aware that the collected ID's or indices are collected on each node of a distributed simulation when using a DistributedSingleThreadNetwork or DistributedMultiThreadNetwork which may lead to a large memory consumption.

Implements WiringMethod.

Definition at line 43 of file OneToOneWiringMethod.cpp.

References SimNetwork::connect(), ConnObjectFactory::init(), WiringMethod::net, and SimObjectPopulation::size().

Here is the call graph for this function:

unsigned OneToOneWiringMethod::connect	(	const SimObjectPopulation &	source,
		const SimObjectPopulation &	destination,
		const Time &	delay,
		bool	collectPairs = `false`,
		WiringMethod::ConnectPairsVector	connectPairs = `WiringMethod::ConnectPairsVector(new vector< pair<SimObject::ID, SimObject::ID> >)`
	)

Definition at line 85 of file OneToOneWiringMethod.cpp.

References SimNetwork::connect(), WiringMethod::net, and SimObjectPopulation::size().

Here is the call graph for this function:

unsigned OneToOneWiringMethod::connect	(	const vector< SimObject::ID::Packed > &	source,
		const vector< SimObject::ID::Packed > &	destination,
		const Time &	delay,
		bool	collectPairs = `false`,
		ConnectPairsVector	connectPairs = `ConnectPairsVector(new vector< pair<SimObject::ID, SimObject::ID> >)`
	)			`[inline]`

Definition at line 63 of file OneToOneWiringMethod.h.

References connect().

Here is the call graph for this function:

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

/home/tnatschl/PCSIM-Sandbox/pcsim/pcsim/construction/OneToOneWiringMethod.h
/home/tnatschl/PCSIM-Sandbox/pcsim/pcsim/construction/OneToOneWiringMethod.cpp


Public Member Functions
	OneToOneWiringMethod (SimNetwork *net)
	New OneToOneWiringMethod which belongs to the given SimNetwork.
	OneToOneWiringMethod (SimNetwork &net)
	New OneToOneWiringMethod which belongs to the given SimNetwork.
virtual	~OneToOneWiringMethod ()
virtual unsigned	connect (const SimObjectPopulation &source, const SimObjectPopulation &destination, ConnectionIterator &iterator, bool collectPairs=false, ConnectPairsVector connectPairs=ConnectPairsVector(new vector< pair< SimObject::ID, SimObject::ID > >))
	Make direct connections between source and dest. population.
virtual SimObject::ID::Vector	connect (const SimObjectPopulation &source, const SimObjectPopulation &destination, const SimObjectFactory &connector, ConnectionIterator &iterator, bool collectIDs=false, bool collectPairs=false, WiringMethod::ConnectPairsVector connectPairs=WiringMethod::ConnectPairsVector(new vector< pair< SimObject::ID, SimObject::ID > >))
	Make connections between source and dest. population using a SimObjectFactory (usually some synapse) to connect the objects.
virtual SimObject::ID::Vector	connect (const SimObjectPopulation &source, const SimObjectPopulation &destination, ConnObjectFactory &connector, ConnectionIterator &iterator, bool collectIDs=false, bool collectPairs=false, WiringMethod::ConnectPairsVector connectPairs=WiringMethod::ConnectPairsVector(new vector< pair< SimObject::ID, SimObject::ID > >))
	Make connections between source and dest. population using a SimObjectFactory (usually some synapse) to connect the objects.
unsigned	connect (const SimObjectPopulation &source, const SimObjectPopulation &destination, const Time &delay, bool collectPairs=false, WiringMethod::ConnectPairsVector connectPairs=WiringMethod::ConnectPairsVector(new vector< pair< SimObject::ID, SimObject::ID > >))
unsigned	connect (const vector< SimObject::ID::Packed > &source, const vector< SimObject::ID::Packed > &destination, const Time &delay, bool collectPairs=false, ConnectPairsVector connectPairs=ConnectPairsVector(new vector< pair< SimObject::ID, SimObject::ID > >))