Public Member Functions
bbp::sonata::CompartmentSet Class Reference

#include <compartment_sets.h>

Public Member Functions

 CompartmentSet (const std::string &json_content)
 
 CompartmentSet (std::shared_ptr< detail::CompartmentSet > &&impl)
 
std::pair< CompartmentSetFilteredIterator, CompartmentSetFilteredIteratorfiltered_crange (Selection selection=Selection({})) const
 
std::size_t size (const Selection &selection=Selection({})) const
 Size of the set, optionally filtered by selection.
 
bool empty () const
 
const std::string & population () const
 Population name.
 
CompartmentLocation operator[] (std::size_t index) const
 Access element by index. It returns a copy!
 
Selection nodeIds () const
 
CompartmentSet filter (const Selection &selection=Selection({})) const
 
std::string toJSON () const
 Serialize to JSON string.
 
bool operator== (const CompartmentSet &other) const
 
bool operator!= (const CompartmentSet &other) const
 

Detailed Description

CompartmentSet public API.

This class represents a set of compartment locations associated with a neuron population. Each compartment is uniquely defined by a (node_id, section_index, offset) triplet. This API supports filtering based on a node_id selection.