Brion  1.7.0
The Blue Brain C++ I/O library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends Macros Pages
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

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

Detailed Description

Read access to a Circuit file.

This class loads the circuit data at creation and will ensure release of resources upon destruction.

Definition at line 34 of file brion/circuit.h.

Constructor & Destructor Documentation

brion::Circuit::~Circuit ( )

Close circuit file.

Version
1.0
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
brion::Circuit::Circuit ( const URI &  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.7

Member Function Documentation

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
size_t brion::Circuit::getNumNeurons ( ) const
Returns
number of neurons stored in the circuit file.
Version
1.0
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: