nest::OffGridSpikeData Class Reference

#include <spike_data.h>

Inheritance diagram for nest::OffGridSpikeData:

Collaboration diagram for nest::OffGridSpikeData:

Public Member Functions
	OffGridSpikeData ()
	OffGridSpikeData (const Target &target, const size_t lag, const double offset)
	OffGridSpikeData (const size_t tid, const synindex syn_id, const size_t lcid, const unsigned int lag, const double offset)
	OffGridSpikeData (const OffGridSpikeData &rhs)
OffGridSpikeData &	operator= (const OffGridSpikeData &rhs)
OffGridSpikeData &	operator= (const SpikeData &rhs)
void	set (const size_t tid, const synindex syn_id, const size_t lcid, const unsigned int lag, const double offset)
template<class TargetT >
void	set (const TargetT &target, const unsigned int lag)
double	get_offset () const
Public Member Functions inherited from nest::SpikeData
	SpikeData ()
	SpikeData (const SpikeData &rhs)
	SpikeData (const Target &target, const size_t lag, const bool is_flush_event)
	SpikeData (const size_t tid, const synindex syn_id, const size_t lcid, const unsigned int lag)
SpikeData &	operator= (const SpikeData &rhs)
void	set (const size_t tid, const synindex syn_id, const size_t lcid, const unsigned int lag, const double offset)
	Required in connection with direct-send events.
template<class TargetT >
void	set (const TargetT &target, const unsigned int lag)
size_t	get_lcid () const
	Returns local connection ID.
void	set_lcid (size_t)
	Sets lcid value.
unsigned int	get_lag () const
	Returns lag in min-delay interval.
size_t	get_tid () const
	Returns thread index.
synindex	get_syn_id () const
	Returns synapse-type index.
unsigned int	get_marker () const
	Returns marker.
void	reset_marker ()
	Resets the status flag to default value.
void	set_complete_marker ()
	Sets the status flag to complete marker.
void	set_end_marker ()
	Sets the status flag to end marker.
void	set_invalid_marker ()
	Sets the status flag to invalid marker.
bool	is_complete_marker () const
	Returns whether the marker is the complete marker.
bool	is_end_marker () const
	Returns whether the marker is the end marker.
bool	is_invalid_marker () const
	Returns whether the marker is the invalid marker.
bool	is_flush_event () const
	Returns whether this spike is a flush event.
double	get_offset () const
	Returns offset.
void	set_flush_event_flag (bool is_flush_event)
	Sets the flush event flag.

Private Attributes
double	offset_

Additional Inherited Members
Protected Attributes inherited from nest::SpikeData
size_t	lcid_: NUM_BITS_LCID
	local connection index
unsigned int	marker_: NUM_BITS_MARKER_SPIKE_DATA
	status flag
unsigned int	flush_event_: NUM_BITS_FLUSH_EVENT
	flush event flag
unsigned int	lag_: NUM_BITS_LAG
	lag in this min-delay interval
unsigned int	tid_: NUM_BITS_TID
	thread index
synindex	syn_id_: NUM_BITS_SYN_ID
	synapse-type index
Static Protected Attributes inherited from nest::SpikeData
static constexpr int	MAX_LAG = generate_max_value( NUM_BITS_LAG )

Constructor & Destructor Documentation

OffGridSpikeData() [1/4]

nest::OffGridSpikeData::OffGridSpikeData ( )

inline

OffGridSpikeData() [2/4]

nest::OffGridSpikeData::OffGridSpikeData ( const Target &  target, const size_t  lag, const double  offset  )

inline

OffGridSpikeData() [3/4]

nest::OffGridSpikeData::OffGridSpikeData ( const size_t  tid, const synindex  syn_id, const size_t  lcid, const unsigned int  lag, const double  offset  )

inline

OffGridSpikeData() [4/4]

nest::OffGridSpikeData::OffGridSpikeData ( const OffGridSpikeData &  rhs )

inline

Member Function Documentation

get_offset()

double nest::OffGridSpikeData::get_offset ( ) const

inline

References offset_.

operator=() [1/2]

OffGridSpikeData & nest::OffGridSpikeData::operator= ( const OffGridSpikeData &  rhs )

inline

References nest::SpikeData::lag_, nest::SpikeData::lcid_, nest::SpikeData::marker_, offset_, nest::SpikeData::syn_id_, and nest::SpikeData::tid_.

operator=() [2/2]

OffGridSpikeData & nest::OffGridSpikeData::operator= ( const SpikeData &  rhs )

inline

References nest::SpikeData::get_lag(), nest::SpikeData::get_lcid(), nest::SpikeData::get_marker(), nest::SpikeData::get_syn_id(), nest::SpikeData::get_tid(), nest::SpikeData::lag_, nest::SpikeData::lcid_, nest::SpikeData::marker_, offset_, nest::SpikeData::syn_id_, and nest::SpikeData::tid_.

Here is the call graph for this function:

set() [1/2]

void nest::OffGridSpikeData::set ( const size_t  tid, const synindex  syn_id, const size_t  lcid, const unsigned int  lag, const double  offset  )

inline

References nest::SpikeData::lag_, nest::SpikeData::lcid_, nest::SpikeData::marker_, nest::SpikeData::MAX_LAG, nest::MAX_LCID, nest::MAX_SYN_ID, nest::MAX_TID, offset_, nest::SPIKE_DATA_ID_DEFAULT, nest::SpikeData::syn_id_, and nest::SpikeData::tid_.

set() [2/2]

template<class TargetT >

void nest::OffGridSpikeData::set ( const TargetT &  target, const unsigned int  lag  )

inline

References offset_, and nest::SpikeData::set().

Here is the call graph for this function:

Member Data Documentation

offset_

double nest::OffGridSpikeData::offset_

private

Referenced by get_offset(), operator=(), operator=(), set(), and set().

---

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

• spike_data.h