Brion  1.5.0
The Blue Brain C++ I/O library
brion::Synapse Class Reference

Read access to a Synapse file. More...

#include <synapse.h>

+ Inheritance diagram for brion::Synapse:
+ Collaboration diagram for brion::Synapse:

Public Member Functions

 ~Synapse ()
 Close synapse file. More...
 
Read API
 Synapse (const std::string &source)
 Open the given source to a synapse file for reading. More...
 
SynapseMatrix read (const uint32_t gid, const uint32_t attributes) const
 Read requested synapse attributes for a given neuron. More...
 
size_t getNumSynapses (const GIDSet &gids) const
 Get the number of synapses for a set of neurons. More...
 

Detailed Description

Read access to a Synapse file.

Following RAII, this class is ready to use after the creation and will ensure release of resources upon destruction. Threadsafety is guaranteed for all provided methods.

Definition at line 37 of file synapse.h.

Constructor & Destructor Documentation

brion::Synapse::~Synapse ( )

Close synapse file.

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

Open the given source to a synapse file for reading.

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

Member Function Documentation

size_t brion::Synapse::getNumSynapses ( const GIDSet &  gids) const

Get the number of synapses for a set of neurons.

Parameters
gidsGIDSet of neurons to consider
Returns
number of synapses for the set of neurons.
Version
1.0
SynapseMatrix brion::Synapse::read ( const uint32_t  gid,
const uint32_t  attributes 
) const

Read requested synapse attributes for a given neuron.

Parameters
gidGID of neuron, empty return value for not found GID
attributesdesired attributes to load into return value
Returns
data matrix containing values for attributes consecutively for each connected neuron
Version
1.0

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