nest::DataLoggingRequest Class Reference

Request data to be logged/logged data to be sent. More...

#include <event.h>

Inheritance diagram for nest::DataLoggingRequest:

Collaboration diagram for nest::DataLoggingRequest:

Public Member Functions
	DataLoggingRequest ()
	Create empty request for use during simulation.
	DataLoggingRequest (const Time &, const std::vector< std::string > &)
	DataLoggingRequest (const Time &, const Time &, const std::vector< std::string > &)
	Create event for given time interval, offset for interval start, and vector of recordables.
DataLoggingRequest *	clone () const override
void	operator() () override
	Deliver the event to receiver.
const Time &	get_recording_interval () const
	Access to stored time interval.
const Time &	get_recording_offset () const
	Access to stored offset.
const std::vector< std::string > &	record_from () const
	Access to vector of recordables.
Public Member Functions inherited from nest::Event
	Event ()
virtual	~Event ()
void	set_receiver (Node &)
	Change pointer to receiving Node.
Node &	get_receiver () const
	Return reference to receiving Node.
size_t	get_receiver_node_id () const
	Return node ID of receiving Node.
Node &	get_sender () const
	Return reference to sending Node.
void	set_sender (Node &)
	Change pointer to sending Node.
size_t	get_sender_node_id () const
	Sender is local.
size_t	retrieve_sender_node_id_from_source_table () const
	Sender is not local.
void	set_sender_node_id (const size_t)
	Change node ID of sending Node.
void	set_sender_node_id_info (const size_t tid, const synindex syn_id, const size_t lcid)
	Set tid, syn_id, lcid of spike_data_.
Time const &	get_stamp () const
	Return time stamp of the event.
void	set_delay_steps (long)
	Set the transmission delay of the event.
long	get_delay_steps () const
	Return transmission delay of the event.
long	get_rel_delivery_steps (const Time &t) const
	Relative spike delivery time in steps.
size_t	get_port () const
	Return the sender port number of the event.
size_t	get_rport () const
	Return the receiver port number of the event.
void	set_port (size_t p)
	Set the port number.
void	set_rport (size_t p)
	Set the receiver port number (r-port).
double	get_offset () const
	Return the creation time offset of the Event.
void	set_offset (double t)
	Set the creation time of the Event.
double	get_weight () const
	Return the weight.
void	set_weight (double t)
	Set weight of the event.
virtual void	set_drift_factor (double)
	Set drift_factor of the event (see DiffusionConnectionEvent).
virtual void	set_diffusion_factor (double)
	Set diffusion_factor of the event (see DiffusionConnectionEvent).
bool	sender_is_valid () const
	Returns true if the pointer to the sender node is valid.
bool	receiver_is_valid () const
	Returns true if the pointer to the receiver node is valid.
bool	is_valid () const
	Check integrity of the event.
void	set_stamp (Time const &)
	Set the time stamp of the event.
void	set_flush_event_flag (bool is_flush_event)
	Sets the flush event flag.
bool	is_flush_event ()
	Returns whether this spike is a flush event.

Private Attributes
Time	recording_interval_
	Interval between two recordings, first is step 1.
Time	recording_offset_
	Offset relative to which the intervals are computed.
std::vector< std::string > const *const	record_from_
	Names of properties to record from.

Additional Inherited Members
Protected Attributes inherited from nest::Event
size_t	sender_node_id_
	node ID of sender or 0
SpikeData	sender_spike_data_
	spike data of sender node, in some cases required to retrieve node ID
Node *	sender_
	Pointer to sender or nullptr.
Node *	receiver_
	Pointer to receiver or nullptr.
size_t	p_
	Sender port number.
size_t	rp_
	Receiver port number (r-port).
long	d_
	Transmission delay.
Time	stamp_
	Time stamp.
long	stamp_steps_
	Time stamp in steps.
double	offset_
	Offset for precise spike times.
double	w_
	Weight of the connection.

Detailed Description

Request data to be logged/logged data to be sent.

See also

DataLoggingReply

Constructor & Destructor Documentation

DataLoggingRequest() [1/3]

nest::DataLoggingRequest::DataLoggingRequest ( )

inline

Create empty request for use during simulation.

Referenced by clone().

Here is the caller graph for this function:

DataLoggingRequest() [2/3]

nest::DataLoggingRequest::DataLoggingRequest ( const Time &  rec_int, const std::vector< std::string > &  recs  )

inline

DataLoggingRequest() [3/3]

nest::DataLoggingRequest::DataLoggingRequest ( const Time &  rec_int, const Time &  rec_offset, const std::vector< std::string > &  recs  )

inline

Create event for given time interval, offset for interval start, and vector of recordables.

Member Function Documentation

clone()

DataLoggingRequest * nest::DataLoggingRequest::clone ( ) const

inlineoverridevirtual

Implements nest::Event.

References DataLoggingRequest().

Here is the call graph for this function:

get_recording_interval()

const Time & nest::DataLoggingRequest::get_recording_interval ( ) const

inline

Access to stored time interval.

References nest::Time::is_finite(), and recording_interval_.

Here is the call graph for this function:

get_recording_offset()

const Time & nest::DataLoggingRequest::get_recording_offset ( ) const

inline

Access to stored offset.

References nest::Time::is_finite(), and recording_offset_.

Here is the call graph for this function:

operator()()

void nest::DataLoggingRequest::operator() ( )

overridevirtual

Deliver the event to receiver.

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

Implements nest::Event.

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

Here is the call graph for this function:

record_from()

const std::vector< std::string > & nest::DataLoggingRequest::record_from ( ) const

inline

Access to vector of recordables.

References record_from_.

Member Data Documentation

record_from_

std::vector< std::string > const* const nest::DataLoggingRequest::record_from_

private

Names of properties to record from.

Note

This pointer shall be nullptr unless the event is sent by a connection routine.

Referenced by record_from().

recording_interval_

Time nest::DataLoggingRequest::recording_interval_

private

Interval between two recordings, first is step 1.

Referenced by get_recording_interval().

recording_offset_

Time nest::DataLoggingRequest::recording_offset_

private

Offset relative to which the intervals are computed.

Referenced by get_recording_offset().

---

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

• event.h
• event.cpp