nest::TargetData Class Reference

Used to communicate part of the connection infrastructure from post- to presynaptic side. More...

#include <target_data.h>

Collaboration diagram for nest::TargetData:

Public Member Functions
void	reset_marker ()
void	set_complete_marker ()
void	set_end_marker ()
void	set_invalid_marker ()
bool	is_complete_marker () const
bool	is_end_marker () const
bool	is_invalid_marker () const
void	set_source_lid (const size_t source_lid)
void	set_source_tid (const size_t source_tid)
size_t	get_source_lid () const
size_t	get_source_tid () const
void	set_is_primary (const bool is_primary)
bool	is_primary () const

Public Attributes
union {
TargetDataFields   target_data
SecondaryTargetDataFields   secondary_data
};
	variant fields

Private Attributes
unsigned int	source_lid_: NUM_BITS_LID
	local id of presynaptic neuron
unsigned int	source_tid_: NUM_BITS_TID
	thread index of presynaptic neuron
unsigned int	marker_: NUM_BITS_MARKER
bool	is_primary_: NUM_BITS_IS_PRIMARY
	TargetData has TargetDataFields else SecondaryTargetDataFields.

Static Private Attributes
static constexpr uint8_t	NUM_BITS_LID = 19U
static constexpr uint8_t	NUM_BITS_MARKER = 2U
static constexpr uint8_t	NUM_BITS_IS_PRIMARY = 1U
static constexpr int	MAX_LID = generate_max_value( NUM_BITS_LID )

Detailed Description

Used to communicate part of the connection infrastructure from post- to presynaptic side.

These are the elements of the MPI buffers.

SeeAlso: SpikeData

Member Function Documentation

get_source_lid()

size_t nest::TargetData::get_source_lid ( ) const

inline

References source_lid_.

Referenced by nest::TargetTable::add_target().

Here is the caller graph for this function:

get_source_tid()

size_t nest::TargetData::get_source_tid ( ) const

inline

References source_tid_.

Referenced by nest::EventDeliveryManager::distribute_target_data_buffers_().

Here is the caller graph for this function:

is_complete_marker()

bool nest::TargetData::is_complete_marker ( ) const

inline

References marker_, and nest::TARGET_DATA_ID_COMPLETE.

is_end_marker()

bool nest::TargetData::is_end_marker ( ) const

inline

References marker_, and nest::TARGET_DATA_ID_END.

Referenced by nest::EventDeliveryManager::distribute_target_data_buffers_().

Here is the caller graph for this function:

is_invalid_marker()

bool nest::TargetData::is_invalid_marker ( ) const

inline

References marker_, and nest::TARGET_DATA_ID_INVALID.

is_primary()

bool nest::TargetData::is_primary ( ) const

inline

References is_primary_.

Referenced by nest::TargetTable::add_target(), and set_is_primary().

Here is the caller graph for this function:

reset_marker()

void nest::TargetData::reset_marker ( )

inline

References marker_, and nest::TARGET_DATA_ID_DEFAULT.

Referenced by nest::ConnectionManager::fill_target_buffer(), and nest::SourceTable::populate_target_data_fields_().

Here is the caller graph for this function:

set_complete_marker()

void nest::TargetData::set_complete_marker ( )

inline

References marker_, and nest::TARGET_DATA_ID_COMPLETE.

set_end_marker()

void nest::TargetData::set_end_marker ( )

inline

References marker_, and nest::TARGET_DATA_ID_END.

set_invalid_marker()

void nest::TargetData::set_invalid_marker ( )

inline

References marker_, and nest::TARGET_DATA_ID_INVALID.

set_is_primary()

void nest::TargetData::set_is_primary ( const bool  is_primary )

inline

References is_primary(), and is_primary_.

Referenced by nest::ConnectionManager::fill_target_buffer(), and nest::SourceTable::populate_target_data_fields_().

Here is the call graph for this function:

Here is the caller graph for this function:

set_source_lid()

void nest::TargetData::set_source_lid ( const size_t  source_lid )

inline

References MAX_LID, and source_lid_.

Referenced by nest::ConnectionManager::fill_target_buffer(), and nest::SourceTable::populate_target_data_fields_().

Here is the caller graph for this function:

set_source_tid()

void nest::TargetData::set_source_tid ( const size_t  source_tid )

inline

References nest::MAX_TID, and source_tid_.

Referenced by nest::ConnectionManager::fill_target_buffer(), and nest::SourceTable::populate_target_data_fields_().

Here is the caller graph for this function:

Member Data Documentation

[union]

union { ... } nest::TargetData

variant fields

is_primary_

bool nest::TargetData::is_primary_

private

TargetData has TargetDataFields else SecondaryTargetDataFields.

Referenced by is_primary(), and set_is_primary().

marker_

unsigned int nest::TargetData::marker_

private

Referenced by is_complete_marker(), is_end_marker(), is_invalid_marker(), reset_marker(), set_complete_marker(), set_end_marker(), and set_invalid_marker().

MAX_LID

constexpr int nest::TargetData::MAX_LID = generate_max_value( NUM_BITS_LID )

staticconstexprprivate

Referenced by set_source_lid().

NUM_BITS_IS_PRIMARY

constexpr uint8_t nest::TargetData::NUM_BITS_IS_PRIMARY = 1U

staticconstexprprivate

NUM_BITS_LID

constexpr uint8_t nest::TargetData::NUM_BITS_LID = 19U

staticconstexprprivate

NUM_BITS_MARKER

constexpr uint8_t nest::TargetData::NUM_BITS_MARKER = 2U

staticconstexprprivate

secondary_data

SecondaryTargetDataFields nest::TargetData::secondary_data

Referenced by nest::TargetTable::add_target(), nest::ConnectionManager::fill_target_buffer(), and nest::SourceTable::populate_target_data_fields_().

source_lid_

unsigned int nest::TargetData::source_lid_

private

local id of presynaptic neuron

Referenced by get_source_lid(), and set_source_lid().

source_tid_

unsigned int nest::TargetData::source_tid_

private

thread index of presynaptic neuron

Referenced by get_source_tid(), and set_source_tid().

target_data

TargetDataFields nest::TargetData::target_data

Referenced by nest::TargetTable::add_target(), nest::ConnectionManager::fill_target_buffer(), and nest::SourceTable::populate_target_data_fields_().

---

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

• target_data.h