Brion  1.7.0
The Blue Brain C++ I/O library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends Macros Pages
brion::SynapseSummary Class Reference

Read access to a Synapse summary file. More...

#include <synapseSummary.h>

+ Inheritance diagram for brion::SynapseSummary:
+ Collaboration diagram for brion::SynapseSummary:

Public Member Functions

 ~SynapseSummary ()
 Close synapse summary file. More...
 
Read API
 SynapseSummary (const std::string &source)
 Open the given source to a synapse summary file for reading. More...
 
SynapseSummaryMatrix read (const uint32_t gid)
 Read afferent and efferent information for a given neuron. More...
 

Detailed Description

Read access to a Synapse summary file.

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

Definition at line 37 of file synapseSummary.h.

Constructor & Destructor Documentation

brion::SynapseSummary::~SynapseSummary ( )

Close synapse summary file.

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

Open the given source to a synapse summary file for reading.

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

Member Function Documentation

SynapseSummaryMatrix brion::SynapseSummary::read ( const uint32_t  gid)

Read afferent and efferent information for a given neuron.

Parameters
gidGID of neuron, empty return value for not found GID
Returns
data matrix containing GID, number of efferent & afferent synapses for each connected neuron
Version
1.0

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