"Callback request event" for use in Device. More...
#include <event.h>
Public Member Functions | |
| void | operator() () |
| Deliver the event to receiver. More... | |
 Public Member Functions inherited from nest::CurrentEvent | |
| CurrentEvent * | clone () const |
| Virtual copy constructor. More... | |
| void | set_current (double_t) |
| double_t | get_current () const |
| Public Member Functions inherited from nest::Event | |
| Event () | |
| virtual | ~Event () |
| void | set_receiver (Node &) |
| Change pointer to receiving Node. More... | |
| Node & | get_receiver () const |
| Return reference to receiving Node. More... | |
| Node & | get_sender () const |
| Return reference to sending Node. More... | |
| void | set_sender (Node &) |
| Change pointer to sending Node. More... | |
| index | get_sender_gid () const |
| Return GID of sending Node. More... | |
| void | set_sender_gid (index) |
| Change GID of sending Node. More... | |
| Time const & | get_stamp () const |
| Return time stamp of the event. More... | |
| void | set_delay (delay) |
| Set the transmission delay of the event. More... | |
| delay | get_delay () const |
| Return transmission delay of the event. More... | |
| delay | get_max_delay () const |
| long_t | get_rel_delivery_steps (const Time &t) const |
| Relative spike delivery time in steps. More... | |
| port | get_port () const |
| Return the sender port number of the event. More... | |
| rport | get_rport () const |
| Return the receiver port number of the event. More... | |
| void | set_port (port p) |
| Set the port number. More... | |
| void | set_rport (rport p) |
| Set the receiver port number (r-port). More... | |
| double_t | get_offset () const |
| Return the creation time offset of the Event. More... | |
| void | set_offset (double_t t) |
| Set the creation time of the Event. More... | |
| weight | get_weight () const |
| Return the weight. More... | |
| void | set_weight (weight t) |
| Set weight of the event. More... | |
| bool | is_valid () const |
| Check integrity of the event. More... | |
| void | set_stamp (Time const &) |
| Set the time stamp of the event. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from nest::Event | |
| index | sender_gid_ |
| GID of sender or -1. More... | |
| Node * | sender_ |
| Pointer to sender or NULL. More... | |
| Node * | receiver_ |
| Pointer to receiver or NULL. More... | |
| port | p_ |
| Sender port number. More... | |
| rport | rp_ |
| Receiver port number (r-port). More... | |
| delay | d_ |
| Transmission delay. More... | |
| Time | stamp_ |
| Time stamp. More... | |
| double | offset_ |
| Offset for precise spike times. More... | |
| weight | w_ |
| Weight of the connection. More... | |
Detailed Description
"Callback request event" for use in Device.
Some Nodes want to perform a function on an event for each of their targets. An example is the noise_generator which needs to draw a random number for each target. The DSCurrentEvent, DirectSendingCurrentEvent, calls sender->event_hook(*this) in its operator() function instead of calling receiver->handle(). The default implementation of Node::event_hook() just calls target->handle(DSCurrentEvent&). Any reimplementation must also execute this call. Otherwise the event will not be delivered. If needed, target->handle(DSCurrentEvent&) may be called more than once.
- Note
- Callback events must only be sent via static_synapse.
Member Function Documentation
|
virtual |
Deliver the event to receiver.
This operator calls the handler for the specific event type at the receiver.
Reimplemented from nest::CurrentEvent.
References nest::Node::event_hook(), and nest::Event::sender_.
The documentation for this class was generated from the following files:
