#include <config.h>
Public Types | |
enum | ConfigStatus { ConfigStatus::invalid, ConfigStatus::complete, ConfigStatus::partial } |
Public Member Functions | |
CircuitConfig (const std::string &contents, const std::string &basePath) | |
ConfigStatus | getCircuitConfigStatus () const |
const std::string & | getNodeSetsPath () const |
std::set< std::string > | listNodePopulations () const |
NodePopulation | getNodePopulation (const std::string &name, const Hdf5Reader &hdf5_reader) const |
NodePopulation | getNodePopulation (const std::string &name) const |
std::set< std::string > | listEdgePopulations () const |
EdgePopulation | getEdgePopulation (const std::string &name, const Hdf5Reader &hdf5_reader) const |
EdgePopulation | getEdgePopulation (const std::string &name) const |
NodePopulationProperties | getNodePopulationProperties (const std::string &name) const |
EdgePopulationProperties | getEdgePopulationProperties (const std::string &name) const |
const std::string & | getExpandedJSON () const |
Static Public Member Functions | |
static CircuitConfig | fromFile (const std::string &path) |
Read access to a SONATA circuit config file.
|
strong |
bbp::sonata::CircuitConfig::CircuitConfig | ( | const std::string & | contents, |
const std::string & | basePath | ||
) |
Parses a SONATA JSON config file.
SonataError | on:
|
|
static |
Loads a SONATA JSON config file from disk and returns a CircuitConfig object which parses it.
SonataError | on:
|
ConfigStatus bbp::sonata::CircuitConfig::getCircuitConfigStatus | ( | ) | const |
Returns the completeness
of the checks that are performed for the circuit; see ConfigStatus
for more information
EdgePopulation bbp::sonata::CircuitConfig::getEdgePopulation | ( | const std::string & | name, |
const Hdf5Reader & | hdf5_reader | ||
) | const |
Creates and returns an EdgePopulation object, initialized from the given population, and the edge network it belongs to.
SonataError | if the given population does not exist in any edge network. |
EdgePopulationProperties bbp::sonata::CircuitConfig::getEdgePopulationProperties | ( | const std::string & | name | ) | const |
Return a structure containing edge population specific properties, falling back to network properties if there are no population-specific ones.
SonataError | if the given population name does not correspond to any existing edge population. |
const std::string& bbp::sonata::CircuitConfig::getExpandedJSON | ( | ) | const |
Returns the configuration file JSON whose variables have been expanded by the manifest entries.
NodePopulation bbp::sonata::CircuitConfig::getNodePopulation | ( | const std::string & | name, |
const Hdf5Reader & | hdf5_reader | ||
) | const |
Creates and returns a NodePopulation object, initialized from the given population, and the node network it belongs to.
SonataError | if the given population does not exist in any node network. |
NodePopulationProperties bbp::sonata::CircuitConfig::getNodePopulationProperties | ( | const std::string & | name | ) | const |
Return a structure containing node population specific properties, falling back to network properties if there are no population-specific ones.
SonataError | if the given population name does not correspond to any existing node population. |
const std::string& bbp::sonata::CircuitConfig::getNodeSetsPath | ( | ) | const |
Returns the path to the node sets file.
std::set<std::string> bbp::sonata::CircuitConfig::listEdgePopulations | ( | ) | const |
Returns a set with all available population names across all the edge networks.
std::set<std::string> bbp::sonata::CircuitConfig::listNodePopulations | ( | ) | const |
Returns a set with all available population names across all the node networks.