nest::Source Class Reference

Stores the node ID of a presynaptic neuron and the number of local targets, along with a flag, whether this entry has been processed yet. More...

#include <source.h>

Public Member Functions
	Source ()
	Source (const size_t node_id, const bool primary)
size_t	get_node_id () const
	Returns this Source's node ID.
void	set_processed (const bool processed)
bool	is_processed () const
void	set_primary (const bool primary)
	Sets whether Source is primary.
bool	is_primary () const
	Returns whether Source is primary.
void	disable ()
	Disables Source.
bool	is_disabled () const
	Returns whether Source is disabled.

Private Attributes
size_t	node_id_: NUM_BITS_NODE_ID
	node ID of source
bool	processed_: 1
	whether this target has already been moved to the MPI buffer
bool	primary_: 1
	source of primary connection
bool	disabled_: 1
	connection has been disabled

Friends
bool	operator< (const Source &lhs, const Source &rhs)
bool	operator> (const Source &lhs, const Source &rhs)
bool	operator== (const Source &lhs, const Source &rhs)

Detailed Description

Stores the node ID of a presynaptic neuron and the number of local targets, along with a flag, whether this entry has been processed yet.

Used in SourceTable.

Constructor & Destructor Documentation

Source() [1/2]

nest::Source::Source ( )

inline

Source() [2/2]

nest::Source::Source ( const size_t  node_id, const bool  primary  )

inlineexplicit

References nest::MAX_NODE_ID.

Member Function Documentation

disable()

void nest::Source::disable ( )

inline

Disables Source.

References disabled_.

get_node_id()

size_t nest::Source::get_node_id ( ) const

inline

Returns this Source's node ID.

References node_id_.

Referenced by nest::SourceTable::find_first_source(), nest::SourceTable::get_next_target_data(), nest::SourceTable::next_entry_has_same_source_(), nest::SourceTable::populate_target_data_fields_(), and nest::SourceTable::previous_entry_has_same_source_().

Here is the caller graph for this function:

is_disabled()

bool nest::Source::is_disabled ( ) const

inline

Returns whether Source is disabled.

References disabled_.

Referenced by nest::SourceTable::find_first_source().

Here is the caller graph for this function:

is_primary()

bool nest::Source::is_primary ( ) const

inline

Returns whether Source is primary.

References primary_.

Referenced by nest::SourceTable::populate_target_data_fields_().

Here is the caller graph for this function:

is_processed()

bool nest::Source::is_processed ( ) const

inline

References processed_.

set_primary()

void nest::Source::set_primary ( const bool  primary )

inline

Sets whether Source is primary.

References primary_.

set_processed()

void nest::Source::set_processed ( const bool  processed )

inline

References processed_.

Referenced by nest::SourceTable::get_next_target_data().

Here is the caller graph for this function:

Friends And Related Symbol Documentation

operator<

bool operator< ( const Source &  lhs, const Source &  rhs  )

friend

operator==

bool operator== ( const Source &  lhs, const Source &  rhs  )

friend

operator>

bool operator> ( const Source &  lhs, const Source &  rhs  )

friend

Member Data Documentation

disabled_

bool nest::Source::disabled_

private

connection has been disabled

Referenced by disable(), and is_disabled().

node_id_

size_t nest::Source::node_id_

private

node ID of source

Referenced by get_node_id().

primary_

bool nest::Source::primary_

private

source of primary connection

Referenced by is_primary(), and set_primary().

processed_

bool nest::Source::processed_

private

whether this target has already been moved to the MPI buffer

Referenced by is_processed(), and set_processed().

---

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

• source.h