spikestream::ConnectionGroup Class Reference

#include <ConnectionGroup.h>

List of all members.

Public Member Functions
	ConnectionGroup ()
	ConnectionGroup (const ConnectionGroupInfo &connGrpInfo)
	~ConnectionGroup ()
unsigned	addConnection (unsigned id, unsigned fromNeuronID, unsigned toNeuronID, float delay, float weight)
unsigned	addConnection (unsigned int fromNeuronID, unsigned int toNeuronID, float delay, float weight)
ConnectionIterator	begin ()
void	clearConnections ()
ConnectionIterator	end ()
unsigned int	getID ()
unsigned int	getFromNeuronGroupID ()
ConnectionGroupInfo	getInfo ()
double	getParameter (const QString &paramName)
QHash< QString, double >	getParameters ()
unsigned	getSynapseTypeID ()
unsigned int	getToNeuronGroupID ()
Connection &	operator[] (unsigned index)
bool	parametersSet ()
void	print (bool printConnections=false)
void	setDescription (const QString &description)
void	setFromNeuronGroupID (unsigned id)
void	setID (unsigned int id)
void	setParameters (QHash< QString, double > &paramMap)
void	setToNeuronGroupID (unsigned id)
int	size ()

---

Detailed Description

Holds all of the connections in a connection group along with their parameters.

Definition at line 19 of file ConnectionGroup.h.

---

Constructor & Destructor Documentation

ConnectionGroup::ConnectionGroup

(

)

Empty constructor

Definition at line 19 of file ConnectionGroup.cpp.

ConnectionGroup::ConnectionGroup

(

const ConnectionGroupInfo &

connGrpInfo

)

Standard constructor

Definition at line 28 of file ConnectionGroup.cpp.

ConnectionGroup::~ConnectionGroup

(

)

Destructor

Definition at line 39 of file ConnectionGroup.cpp.

---

Member Function Documentation

unsigned ConnectionGroup::addConnection	(	unsigned	id,
		unsigned	fromNeuronID,
		unsigned	toNeuronID,
		float	delay,
		float	weight
	)

Adds a connection to the group using the specified ID and returns the index of the connection. The connection can be accessed later using [].

Definition at line 58 of file ConnectionGroup.cpp.

unsigned ConnectionGroup::addConnection	(	unsigned int	fromNeuronID,
		unsigned int	toNeuronID,
		float	delay,
		float	weight
	)

Adds a connection to the group using a temporary ID and returns the index of the connection. The connection can be accessed later using [].

Definition at line 69 of file ConnectionGroup.cpp.

ConnectionIterator ConnectionGroup::begin

(

)

Returns iterator pointing to beginning of connection group

Definition at line 79 of file ConnectionGroup.cpp.

void ConnectionGroup::clearConnections

(

)

Removes all connections from this group

Definition at line 91 of file ConnectionGroup.cpp.

ConnectionIterator ConnectionGroup::end

(

)

Returns iterator pointing to end of connection group

Definition at line 85 of file ConnectionGroup.cpp.

unsigned int spikestream::ConnectionGroup::getFromNeuronGroupID

(

)

[inline]

Definition at line 30 of file ConnectionGroup.h.

unsigned int spikestream::ConnectionGroup::getID

(

)

[inline]

Definition at line 29 of file ConnectionGroup.h.

ConnectionGroupInfo spikestream::ConnectionGroup::getInfo

(

)

[inline]

Definition at line 31 of file ConnectionGroup.h.

double ConnectionGroup::getParameter

(

const QString &

paramName

)

Returns the value of a named parameter. Throws an exception if the parameter cannot be found.

Definition at line 98 of file ConnectionGroup.cpp.

QHash<QString, double> spikestream::ConnectionGroup::getParameters

(

)

[inline]

Definition at line 33 of file ConnectionGroup.h.

unsigned ConnectionGroup::getSynapseTypeID

(

)

Returns the ID of the synapse type of this connection group

Definition at line 106 of file ConnectionGroup.cpp.

unsigned int spikestream::ConnectionGroup::getToNeuronGroupID

(

)

[inline]

Definition at line 35 of file ConnectionGroup.h.

Connection & ConnectionGroup::operator[]

(

unsigned

index

)

Returns a reference to the operator at a specific index.

Definition at line 112 of file ConnectionGroup.cpp.

bool ConnectionGroup::parametersSet

(

)

Returns true if the parameters have been set.

Definition at line 120 of file ConnectionGroup.cpp.

void ConnectionGroup::print

(

bool

printConnections = false

)

Prints out the neuron group for debugging.

Definition at line 128 of file ConnectionGroup.cpp.

void ConnectionGroup::setDescription

(

const QString &

description

)

Sets the description of the connection group

Definition at line 142 of file ConnectionGroup.cpp.

void ConnectionGroup::setFromNeuronGroupID

(

unsigned

id

)

Sets the FROM neuron group ID

Definition at line 148 of file ConnectionGroup.cpp.

void spikestream::ConnectionGroup::setID

(

unsigned int

id

)

[inline]

Definition at line 41 of file ConnectionGroup.h.

void ConnectionGroup::setParameters

(

QHash< QString, double > &

paramMap

)

Sets the parameters of the connection group. Throws an exception if the parameters do not match those in the synapse type.

Definition at line 155 of file ConnectionGroup.cpp.

void ConnectionGroup::setToNeuronGroupID

(

unsigned

id

)

Sets the TO neuron group ID

Definition at line 172 of file ConnectionGroup.cpp.

int spikestream::ConnectionGroup::size

(

)

[inline]

Definition at line 44 of file ConnectionGroup.h.

---

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

• ConnectionGroup.h
• ConnectionGroup.cpp