bbp::sonata::CompartmentLocation Struct Reference

#include <compartment_sets.h>

Public Member Functions
bool	operator== (const CompartmentLocation &other) const
bool	operator!= (const CompartmentLocation &other) const

Public Attributes
uint64_t	nodeId = 0
uint64_t	sectionIndex = 0
double	offset = 0.0

Detailed Description

CompartmentLocation.

This struct uniquely identifies a compartment by a set of node_id, section_index and offset:

• node_id: Global ID of the cell (Neuron) to which the compartment belongs. No overlaps among populations.
• section_index: Absolute section index. Progressive index that uniquely identifies the section. There is a mapping between neuron section names (i.e. dend[10]) and this index.
• offset: Offset of the compartment along the section. The offset is a value between 0 and 1

Note: it cannot go inside CompartmentSet because then CompartmentSetFilteredIterator needs the full definition of CompartmentSet and CompartmentSet needs the full definition of CompartmentSetFilteredIterator.

Member Function Documentation

operator==()

bool bbp::sonata::CompartmentLocation::operator== ( const CompartmentLocation &  other ) const

inline

Comparator. Used to compare vectors in CompartmentSet. More idiomatic than defining a comaprator on the fly