mech_mapping.hpp

Go to the documentation of this file.

/*
# =============================================================================
# Copyright (c) 2016 - 2021 Blue Brain Project/EPFL
#
# See top-level LICENSE file for details.
# =============================================================================
*/
 
#pragma once
 
#include <string_view>
 
/*
 * todo : currently mod2c has exactly 4 different variable categories
 * that are registered to coreneuron.
 */
#define NB_MECH_VAR_CATEGORIES 4
 
/*
 * SerializedNames
 *
 * names are passed serialized using the following format:
 * SerializedNames : {"0",[[<CategorieNames>,]*0,]* [[<CategorieNames>,]* 0]}
 * All categories must be filled, if they are emtpy, just an other 0 follow.
 *
 * ex: {"0", "name1", "name2", 0, "name3, "name4", 0,0,0}
 *     This means the first categorie with names {name1,name2},
 *     the second categorie with {name3, name4}, 2 last categories are empty
 */
namespace coreneuron {
struct Memb_list;
 
using SerializedNames = const char**;
 
// return pointer to value of a variable's mechanism, or nullptr if not found
double* get_var_location_from_var_name(int mech_id,
                                       const std::string_view mech_name,
                                       const std::string_view variable_name,
                                       Memb_list* ml,
                                       int local_index);
 
// initialize mapping of variable names of mechanism, to their places in memory
void register_all_variables_offsets(int mech_id, SerializedNames variable_names);
 
}  // namespace coreneuron