PySimObjectStub Class Reference

#include <PySimObjectStub.h>

Inheritance diagram for PySimObjectStub:

Collaboration diagram for PySimObjectStub:

List of all members.

Public Types

typedef hash_map< size_t,
SimObject::PortType,
PCSIM::hash< size_t > > port_list_t

Public Member Functions

PySimObjectStub ()

virtual ~PySimObjectStub ()

virtual void defineOutputPort (port_t p, SimObject::PortType port_type)

virtual void defineInputPort (port_t p, SimObject::PortType port_type)

virtual int nSpikeInputPorts () const

virtual int nSpikeOutputPorts () const

virtual int nAnalogInputPorts () const

virtual int nAnalogOutputPorts () const

virtual SimObject::PortType outputPortType (port_t p) const

virtual SimObject::PortType inputPortType (port_t p) const

virtual int reset (double dt)

Called at the beginning of a simulation at t=0.

virtual int advance (AdvanceInfo const &)

Calculate the next state and output/propagate the result to succesors/outgoing objects.

virtual int spikeHit (spikeport_t port, SpikeEvent const &spike)

void setSpike (port_t p, AdvanceInfo &ai)

Methods for defining the model to be simulated

virtual int init (InitializeInfo *ii)

Called during network initialization (prior to reset).

virtual int check (void)

Check the internal consistency of the object.

virtual int adjust (double dt)

This tells the object that it should adjust to a new simulation time step width.

virtual double getManagedDelay () const

In- and output of analog values

virtual double getAnalogOutput (analog_port_id_t port=0) const

Return the analog value currently associated with the given port.

virtual void setAnalogInput (double value, analog_port_id_t port=0)

Analog input to given port.

virtual bool owned_by_net ()

Returns a flag whether the sim object is owned by the network or not.

Protected Attributes

port_list_t output_ports

port_list_t input_ports

int n_analog_input_ports

int n_analog_output_ports

int n_spiking_input_ports

int n_spiking_output_ports

Detailed Description

Definition at line 17 of file PySimObjectStub.h.

Member Typedef Documentation

typedef hash_map< size_t, SimObject::PortType, PCSIM::hash<size_t> > PySimObjectStub::port_list_t

Definition at line 22 of file PySimObjectStub.h.

Constructor & Destructor Documentation

PySimObjectStub::PySimObjectStub ( ) [inline]

Definition at line 24 of file PySimObjectStub.h.

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

Definition at line 34 of file PySimObjectStub.h.

Member Function Documentation

virtual void PySimObjectStub::defineOutputPort	(	port_t	p,
		SimObject::PortType	port_type
	)			`[inline, virtual]`

Definition at line 38 of file PySimObjectStub.h.

References SimObject::analog, MultipleOutputSpikeSender::defineSpikeOutputPort(), n_analog_output_ports, n_spiking_output_ports, output_ports, and SimObject::spiking.

Here is the call graph for this function:

virtual void PySimObjectStub::defineInputPort	(	port_t	p,
		SimObject::PortType	port_type
	)			`[inline, virtual]`

Definition at line 51 of file PySimObjectStub.h.

References SimObject::analog, input_ports, n_analog_input_ports, n_spiking_input_ports, and SimObject::spiking.

virtual int PySimObjectStub::nSpikeInputPorts ( ) const [inline, virtual]

Reimplemented from SimObject.

Definition at line 63 of file PySimObjectStub.h.

References n_spiking_input_ports.

virtual int PySimObjectStub::nSpikeOutputPorts ( ) const [inline, virtual]

Reimplemented from SimObject.

Definition at line 68 of file PySimObjectStub.h.

References n_spiking_output_ports.

virtual int PySimObjectStub::nAnalogInputPorts ( ) const [inline, virtual]

Reimplemented from SimObject.

Definition at line 73 of file PySimObjectStub.h.

References n_analog_input_ports.

virtual int PySimObjectStub::nAnalogOutputPorts ( ) const [inline, virtual]

Reimplemented from SimObject.

Definition at line 78 of file PySimObjectStub.h.

References n_analog_output_ports.

virtual SimObject::PortType PySimObjectStub::outputPortType ( port_t p ) const [inline, virtual]

Reimplemented from SimObject.

Definition at line 83 of file PySimObjectStub.h.

References output_ports, and SimObject::undefined.

virtual SimObject::PortType PySimObjectStub::inputPortType ( port_t p ) const [inline, virtual]

Reimplemented from SimObject.

Definition at line 92 of file PySimObjectStub.h.

References input_ports, and SimObject::undefined.

virtual int PySimObjectStub::reset ( double dt ) [inline, virtual]

Called at the beginning of a simulation at t=0.

Reimplemented from SimObject.

Definition at line 102 of file PySimObjectStub.h.

virtual int PySimObjectStub::advance ( AdvanceInfo const & ) [inline, virtual]

Calculate the next state and output/propagate the result to succesors/outgoing objects.

The return value of advance contains several bits of information which can be decoded with the bit masks ADVANCEFLAG_* like ADVANCEFLAG_HASSPIKED and ADVANCEFLAG_DEACTIVATE.

Reimplemented from SimObject.

Definition at line 111 of file PySimObjectStub.h.

virtual int PySimObjectStub::spikeHit	(	spikeport_t	port,
		SpikeEvent const &	spike
	)			`[inline, virtual]`

Function to be called if the object is hit by a spike Called by spike exchange mechanims if a spike hits (arrives at) the object A return value of greater 0 indicates that the object is currently not active and the sim engine has to put this object into its list of active spike receivers. A return value of 0 indicates the the object is currently active (i.e. is already in the list of active receviers) and need not to be put into the list of active synapses.

Reimplemented from SimObject.

Definition at line 125 of file PySimObjectStub.h.

virtual int PySimObjectStub::init ( InitializeInfo * ii ) [inline, virtual]

Called during network initialization (prior to reset).

Reimplemented from SimObject.

Definition at line 137 of file PySimObjectStub.h.

virtual int PySimObjectStub::check ( void ) [inline, virtual]

Check the internal consistency of the object.

Reimplemented from SimObject.

Definition at line 143 of file PySimObjectStub.h.

virtual int PySimObjectStub::adjust ( double dt ) [inline, virtual]

This tells the object that it should adjust to a new simulation time step width.

Reimplemented from SimObject.

Definition at line 151 of file PySimObjectStub.h.

virtual double PySimObjectStub::getManagedDelay ( ) const [inline, virtual]

Reimplemented from SimObject.

Definition at line 161 of file PySimObjectStub.h.

virtual double PySimObjectStub::getAnalogOutput ( analog_port_id_t port = 0 ) const [inline, virtual]

Return the analog value currently associated with the given port.

Reimplemented from SimObject.

Definition at line 173 of file PySimObjectStub.h.

virtual void PySimObjectStub::setAnalogInput	(	double	value,
		analog_port_id_t	port = `0`
	)			`[inline, virtual]`

Analog input to given port.

Reimplemented from SimObject.

Definition at line 179 of file PySimObjectStub.h.

References NOOP.

virtual bool PySimObjectStub::owned_by_net ( ) [inline, virtual]

Returns a flag whether the sim object is owned by the network or not.

If it is owned by the network then it is deleted when the network object is destroyed. The python sim objects are not owned by the network

Reimplemented from SimObject.

Definition at line 184 of file PySimObjectStub.h.

void PySimObjectStub::setSpike	(	port_t	p,
		AdvanceInfo &	ai
	)			`[inline]`

Definition at line 191 of file PySimObjectStub.h.

References MultipleOutputSpikeSender::getSpikePort(), and SpikeOutputPort::setSpike().

Here is the call graph for this function:

Member Data Documentation

port_list_t PySimObjectStub::output_ports [protected]

Definition at line 194 of file PySimObjectStub.h.

Referenced by defineOutputPort(), and outputPortType().

port_list_t PySimObjectStub::input_ports [protected]

Definition at line 199 of file PySimObjectStub.h.

Referenced by defineInputPort(), and inputPortType().

int PySimObjectStub::n_analog_input_ports [protected]

Definition at line 201 of file PySimObjectStub.h.

Referenced by defineInputPort(), and nAnalogInputPorts().

int PySimObjectStub::n_analog_output_ports [protected]

Definition at line 202 of file PySimObjectStub.h.

Referenced by defineOutputPort(), and nAnalogOutputPorts().

int PySimObjectStub::n_spiking_input_ports [protected]

Definition at line 203 of file PySimObjectStub.h.

Referenced by defineInputPort(), and nSpikeInputPorts().

int PySimObjectStub::n_spiking_output_ports [protected]

Definition at line 204 of file PySimObjectStub.h.

Referenced by defineOutputPort(), and nSpikeOutputPorts().

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

/home/tnatschl/PCSIM-Sandbox/pcsim/pcsim/simobjects/PySimObjectStub.h


Public Types
typedef hash_map< size_t, SimObject::PortType, PCSIM::hash< size_t > >	port_list_t
Public Member Functions
	PySimObjectStub ()
virtual	~PySimObjectStub ()
virtual void	defineOutputPort (port_t p, SimObject::PortType port_type)
virtual void	defineInputPort (port_t p, SimObject::PortType port_type)
virtual int	nSpikeInputPorts () const
virtual int	nSpikeOutputPorts () const
virtual int	nAnalogInputPorts () const
virtual int	nAnalogOutputPorts () const
virtual SimObject::PortType	outputPortType (port_t p) const
virtual SimObject::PortType	inputPortType (port_t p) const
virtual int	reset (double dt)
	Called at the beginning of a simulation at t=0.
virtual int	advance (AdvanceInfo const &)
	Calculate the next state and output/propagate the result to succesors/outgoing objects.
virtual int	spikeHit (spikeport_t port, SpikeEvent const &spike)
void	setSpike (port_t p, AdvanceInfo &ai)
Methods for defining the model to be simulated
virtual int	init (InitializeInfo *ii)
	Called during network initialization (prior to reset).
virtual int	check (void)
	Check the internal consistency of the object.
virtual int	adjust (double dt)
	This tells the object that it should adjust to a new simulation time step width.
virtual double	getManagedDelay () const
In- and output of analog values
virtual double	getAnalogOutput (analog_port_id_t port=0) const
	Return the analog value currently associated with the given port.
virtual void	setAnalogInput (double value, analog_port_id_t port=0)
	Analog input to given port.
virtual bool	owned_by_net ()
	Returns a flag whether the sim object is owned by the network or not.
Protected Attributes
port_list_t	output_ports
port_list_t	input_ports
int	n_analog_input_ports
int	n_analog_output_ports
int	n_spiking_input_ports
int	n_spiking_output_ports