Brion  1.6.0
The Blue Brain C++ I/O library
brion::Circuit Class Reference

Read access to a Circuit file. More...

#include <circuit.h>

+ Inheritance diagram for brion::Circuit:
+ Collaboration diagram for brion::Circuit:

Public Member Functions

BRION_API ~Circuit ()
 Close circuit file. More...
 
Read API
BRION_API Circuit (const std::string &source)
 Open given filepath to a circuit file for reading. More...
 
BRION_API NeuronMatrix get (const GIDSet &gids, const uint32_t attributes) const
 Retrieve neuron attributes for set of neurons. More...
 
BRION_API size_t getNumNeurons () const
 
BRION_API Strings getTypes (const NeuronClass type) const
 Get type information for the neurons in the circuit. More...
 

Detailed Description

Read access to a Circuit file.

Following RAII, this class is ready to use after the creation and will ensure release of resources upon destruction.

Definition at line 36 of file circuit.h.

Constructor & Destructor Documentation

BRION_API brion::Circuit::~Circuit ( )

Close circuit file.

Version
1.0
BRION_API brion::Circuit::Circuit ( const std::string &  source)
explicit

Open given filepath to a circuit file for reading.

Parameters
sourcefilepath to circuit file
Exceptions
std::runtime_errorif file is not a valid circuit file
Version
1.0

Member Function Documentation

BRION_API NeuronMatrix brion::Circuit::get ( const GIDSet gids,
const uint32_t  attributes 
) const

Retrieve neuron attributes for set of neurons.

Parameters
gidsset of neurons of interest; if empty, all neurons in the circuit file are considered
attributesbitset of brion::NeuronAttributes to load into return value
Returns
data matrix containing values for the given attributes stored in a consecutive way
Exceptions
std::runtime_errorif any GID is out of range.
Version
1.0
BRION_API size_t brion::Circuit::getNumNeurons ( ) const
Returns
number of neurons stored in the circuit file.
Version
1.0
BRION_API Strings brion::Circuit::getTypes ( const NeuronClass  type) const

Get type information for the neurons in the circuit.

Parameters
typedesired type of information
Returns
list of type information
Version
1.0

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