NEST  2.6.0,not_revisioned_source_dir@0
Public Member Functions | Private Attributes | List of all members
nest::CurrentEvent Class Reference

Event for electrical currents. More...

#include <event.h>

Inheritance diagram for nest::CurrentEvent:
nest::Event nest::DSCurrentEvent

Public Member Functions

void operator() ()
 Deliver the event to receiver. More...
 
CurrentEventclone () 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...
 
Nodeget_receiver () const
 Return reference to receiving Node. More...
 
Nodeget_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

double_t c_
 

Additional Inherited Members

- Protected Attributes inherited from nest::Event
index sender_gid_
 GID of sender or -1. More...
 
Nodesender_
 Pointer to sender or NULL. More...
 
Nodereceiver_
 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

Event for electrical currents.

Used to send currents from one node to the next.

Member Function Documentation

CurrentEvent * nest::CurrentEvent::clone ( ) const
inlinevirtual

Virtual copy constructor.

Implements nest::Event.

double_t nest::CurrentEvent::get_current ( ) const
inline
void nest::CurrentEvent::operator() ( )
virtual

Deliver the event to receiver.

This operator calls the handler for the specific event type at the receiver.

Implements nest::Event.

Reimplemented in nest::DSCurrentEvent.

References nest::Node::handle(), and nest::Event::receiver_.

void nest::CurrentEvent::set_current ( double_t  c)
inline

Member Data Documentation

double_t nest::CurrentEvent::c_
private

Referenced by get_current(), and set_current().


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