Section to segment mapping. More...

#include <nrnsection_mapping.hpp>

Public Member Functions
	SecMapping ()=default

	SecMapping (std::string s)

size_t	num_sections () const noexcept
	return total number of sections in section list More...

size_t	num_segments () const
	return number of segments in section list More...

void	add_segment (int sec, int seg)
	add section to associated segment More...

Public Attributes
std::string	name
	name of section list More...

secseg_map_type	secmap
	map of section and associated segments More...

Detailed Description

Section to segment mapping.

For a section list (of a particulat type), store mapping of section to segments a section is a arbitrary user classification to recognize some segments (ex: api, soma, dend, axon)

Definition at line 34 of file nrnsection_mapping.hpp.

Constructor & Destructor Documentation

◆ SecMapping() [1/2]

coreneuron::SecMapping::SecMapping ( )

default

◆ SecMapping() [2/2]

coreneuron::SecMapping::SecMapping ( std::string s )

inlineexplicit

Definition at line 43 of file nrnsection_mapping.hpp.

Member Function Documentation

◆ add_segment()

void coreneuron::SecMapping::add_segment	(	int	sec,
		int	seg
	)

inline

add section to associated segment

Definition at line 59 of file nrnsection_mapping.hpp.

◆ num_sections()

size_t coreneuron::SecMapping::num_sections ( ) const

inlinenoexcept

return total number of sections in section list

Definition at line 47 of file nrnsection_mapping.hpp.

◆ num_segments()

size_t coreneuron::SecMapping::num_segments ( ) const

inline

return number of segments in section list

Definition at line 52 of file nrnsection_mapping.hpp.

Member Data Documentation

◆ name

std::string coreneuron::SecMapping::name

name of section list

Definition at line 36 of file nrnsection_mapping.hpp.

◆ secmap

secseg_map_type coreneuron::SecMapping::secmap

map of section and associated segments

Definition at line 39 of file nrnsection_mapping.hpp.

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

/home/docs/checkouts/readthedocs.org/user_builds/nrn/checkouts/3466/src/coreneuron/io/nrnsection_mapping.hpp

Public Member Functions

Public Attributes