Event for transmitting arbitrary data. More...
#include <event.h>
Inheritance diagram for nest::DataEvent< D >:
Public Member Functions | |
| void | set_pointer (D &data) |
| lockPTR< D > | get_pointer () const |
 Public Member Functions inherited from nest::Event | |
| Event () | |
| virtual | ~Event () |
| virtual Event * | clone () const =0 |
| Virtual copy constructor. More... | |
| virtual void | operator() ()=0 |
| Deliver the event to receiver. More... | |
| 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... | |
Private Attributes | |
| lockPTR< D > | data_ |
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
template<typename D>
class nest::DataEvent< D >
Event for transmitting arbitrary data.
This event type may be used for transmitting arbitrary data between events, e.g., images or their FFTs. A lockptr to the data is transmitted. The date type is given as a template parameter.
- Note
- : Data is passed via a lockptr. The receiver should copy the data at once, otherwise it may be modified by the sender. I hope this scheme is thread-safe, as long as the receiver copies the data at once. HEP.
- : This is a base class. Actual event types had to be derived, since operator() cannot be instantiated otherwise.
Member Function Documentation
template<typename D >
|
inline |
template<typename D>
|
inline |
Member Data Documentation
template<typename D>
|
private |
The documentation for this class was generated from the following file:
