Detailed Description

Definition at line 32 of file nrn_filehandler.hpp.

#include <nrn_filehandler.hpp>

Public Types
enum	parse_action { read, seek }
	Defined flag values for parse_array() More...

Public Member Functions
	FileHandler ()

	FileHandler (const std::string &filename)

void	open (const std::string &filename, std::ios::openmode mode=std::ios::in)
	Preserving chkpnt state, move to a new file. More...

bool	fail () const
	Is the file not open. More...

bool	eof ()
	nothing more to read More...

int	checkpoint () const
	Query chkpnt state. More...

void	checkpoint (int c)
	Explicitly override chkpnt state. More...

void	record_checkpoint ()
	Record current chkpnt state. More...

void	restore_checkpoint ()
	Restored last recorded chkpnt state. More...

int	read_int ()
	Parse a single integer entry. More...

void	read_mapping_count (int gid, int nsec, int nseg, int nseclist)
	Parse a neuron mapping count entries. More...

void	read_mapping_cell_count (int *count)
	Reads number of cells in parsing file. More...

template<typename T >
int	read_mapping_info (T *mapinfo)
	Parse a neuron section segment mapping. More...

template<typename T >
T *	parse_array (T *p, size_t count, parse_action flag)
	Generic parse function for an array of fixed length. More...

template<typename T >
T *	read_array (T *p, size_t count)
	Read an integer array of fixed length. More...

template<typename T >
T *	read_array (size_t count)
	Allocate and read an integer array of fixed length. More...

template<typename T >
std::vector< T >	read_vector (size_t count)

void	close ()
	Close currently open file. More...

template<typename T >
void	write_array (T *p, size_t nb_elements)
	Write an 1D array. More...

template<typename T >
void	write_array (T *p, size_t nb_elements, size_t line_width, size_t nb_lines, bool to_transpose=false)
	Write a padded array. More...

template<typename T >
FileHandler &	operator<< (const T &scalar)

Static Public Member Functions
static bool	file_exist (const std::string &filename)

Private Member Functions
void	read_checkpoint_assert ()
	Read a checkpoint line, bump our chkpnt counter, and assert equality. More...

	FileHandler (const FileHandler &)=delete

FileHandler &	operator= (const FileHandler &)=delete

void	write_checkpoint ()

Private Attributes
std::fstream	F
	File stream associated with reader. More...

std::ios_base::openmode	current_mode
	File open mode (not stored in fstream) More...

int	chkpnt
	Current checkpoint number state. More...

int	stored_chkpnt
	last "remembered" checkpoint number state. More...

Member Enumeration Documentation

◆ parse_action

enum coreneuron::FileHandler::parse_action

Defined flag values for parse_array()

Enumerator
read
seek

Definition at line 140 of file nrn_filehandler.hpp.

Constructor & Destructor Documentation

◆ FileHandler() [1/3]

coreneuron::FileHandler::FileHandler ( const FileHandler & )

privatedelete

◆ FileHandler() [2/3]

coreneuron::FileHandler::FileHandler ( )

inline

Definition at line 50 of file nrn_filehandler.hpp.

◆ FileHandler() [3/3]

coreneuron::FileHandler::FileHandler ( const std::string & filename )

explicit

Definition at line 14 of file nrn_filehandler.cpp.

Member Function Documentation

◆ checkpoint() [1/2]

int coreneuron::FileHandler::checkpoint ( ) const

inline

Query chkpnt state.

Definition at line 70 of file nrn_filehandler.hpp.

◆ checkpoint() [2/2]

void coreneuron::FileHandler::checkpoint ( int c )

inline

Explicitly override chkpnt state.

Definition at line 75 of file nrn_filehandler.hpp.

◆ close()

void coreneuron::FileHandler::close ( )

Close currently open file.

Definition at line 104 of file nrn_filehandler.cpp.

◆ eof()

bool coreneuron::FileHandler::eof ( )

nothing more to read

Definition at line 45 of file nrn_filehandler.cpp.

◆ fail()

bool coreneuron::FileHandler::fail ( ) const

inline

Is the file not open.

Definition at line 60 of file nrn_filehandler.hpp.

◆ file_exist()

bool coreneuron::FileHandler::file_exist ( const std::string & filename )

static

Definition at line 20 of file nrn_filehandler.cpp.

◆ open()

void coreneuron::FileHandler::open	(	const std::string &	filename,
		std::ios::openmode	mode = `std::ios::in`
	)

Preserving chkpnt state, move to a new file.

Definition at line 25 of file nrn_filehandler.cpp.

◆ operator<<()

template<typename T >

FileHandler& coreneuron::FileHandler::operator<< ( const T & scalar )

inline

Definition at line 241 of file nrn_filehandler.hpp.

◆ operator=()

FileHandler& coreneuron::FileHandler::operator= ( const FileHandler & )

privatedelete

◆ parse_array()

template<typename T >

T* coreneuron::FileHandler::parse_array	(	T *	p,
		size_t	count,
		parse_action	flag
	)

inline

Generic parse function for an array of fixed length.

Template Parameters

T	the array element type: may be `int` or `double`.

Parameters

p	pointer to the target in memory for reading into.
count	number of items of type T to parse.
action	whether to validate and skip (`seek`) or copy array into memory (`read`).

Returns: the supplied pointer value.

Error if count is non-zero, flag is read, and the supplied pointer is null.

Arrays are represented by a checkpoint line followed by the array items in increasing index order, in the native binary representation of the writing process.

Definition at line 159 of file nrn_filehandler.hpp.

◆ read_array() [1/2]

template<typename T >

T* coreneuron::FileHandler::read_array ( size_t count )

inline

Allocate and read an integer array of fixed length.

Definition at line 187 of file nrn_filehandler.hpp.

◆ read_array() [2/2]

template<typename T >

T* coreneuron::FileHandler::read_array	(	T *	p,
		size_t	count
	)

inline

Read an integer array of fixed length.

Definition at line 181 of file nrn_filehandler.hpp.

◆ read_checkpoint_assert()

void coreneuron::FileHandler::read_checkpoint_assert ( )

private

Read a checkpoint line, bump our chkpnt counter, and assert equality.

Checkpoint information is represented by a sequence "checkpt %d\n" where d is a scanf-compatible representation of the checkpoint integer.

Definition at line 85 of file nrn_filehandler.cpp.

◆ read_int()

int coreneuron::FileHandler::read_int ( )

Parse a single integer entry.

Single integer entries are represented by their standard (C locale) text representation, followed by a newline. Extraneous characters following the integer but preceding the newline are ignore.

Definition at line 57 of file nrn_filehandler.cpp.

◆ read_mapping_cell_count()

void coreneuron::FileHandler::read_mapping_cell_count ( int * count )

Reads number of cells in parsing file.

Definition at line 81 of file nrn_filehandler.cpp.

◆ read_mapping_count()

void coreneuron::FileHandler::read_mapping_count	(	int *	gid,
		int *	nsec,
		int *	nseg,
		int *	nseclist
	)

Parse a neuron mapping count entries.

Reads neuron mapping info which is represented by gid, #sections, #segments, #section lists

mapping file has extra strings, ignore those

Definition at line 70 of file nrn_filehandler.cpp.

◆ read_mapping_info()

template<typename T >

int coreneuron::FileHandler::read_mapping_info ( T * mapinfo )

inline

Parse a neuron section segment mapping.

Read count no of mappings for section to segment

Definition at line 113 of file nrn_filehandler.hpp.

◆ read_vector()

template<typename T >

std::vector<T> coreneuron::FileHandler::read_vector ( size_t count )

inline

Definition at line 192 of file nrn_filehandler.hpp.

◆ record_checkpoint()

void coreneuron::FileHandler::record_checkpoint ( )

inline

Record current chkpnt state.

Definition at line 80 of file nrn_filehandler.hpp.

◆ restore_checkpoint()

void coreneuron::FileHandler::restore_checkpoint ( )

inline

Restored last recorded chkpnt state.

Definition at line 85 of file nrn_filehandler.hpp.

◆ write_array() [1/2]

template<typename T >

void coreneuron::FileHandler::write_array	(	T *	p,
		size_t	nb_elements
	)

inline

Write an 1D array.

Definition at line 203 of file nrn_filehandler.hpp.

◆ write_array() [2/2]

template<typename T >

void coreneuron::FileHandler::write_array	(	T *	p,
		size_t	nb_elements,
		size_t	line_width,
		size_t	nb_lines,
		bool	to_transpose = `false`
	)

inline

Write a padded array.

nb_elements is number of elements to write per line, line_width is full size of a line in nb elements

Definition at line 214 of file nrn_filehandler.hpp.

◆ write_checkpoint()

void coreneuron::FileHandler::write_checkpoint ( )

inlineprivate

Definition at line 252 of file nrn_filehandler.hpp.

Member Data Documentation

◆ chkpnt

int coreneuron::FileHandler::chkpnt

private

Current checkpoint number state.

Definition at line 35 of file nrn_filehandler.hpp.

◆ current_mode

std::ios_base::openmode coreneuron::FileHandler::current_mode

private

File open mode (not stored in fstream)

Definition at line 34 of file nrn_filehandler.hpp.

◆ F

std::fstream coreneuron::FileHandler::F

private

File stream associated with reader.

Definition at line 33 of file nrn_filehandler.hpp.

◆ stored_chkpnt

int coreneuron::FileHandler::stored_chkpnt

private

last "remembered" checkpoint number state.

Definition at line 36 of file nrn_filehandler.hpp.

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

/home/runner/work/CoreNeuron/CoreNeuron/coreneuron/io/nrn_filehandler.hpp
/home/runner/work/CoreNeuron/CoreNeuron/coreneuron/io/nrn_filehandler.cpp

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Member Enumeration Documentation

◆ parse_action

Constructor & Destructor Documentation

◆ FileHandler() [1/3]

◆ FileHandler() [2/3]

◆ FileHandler() [3/3]

Member Function Documentation

◆ checkpoint() [1/2]

◆ checkpoint() [2/2]

◆ close()

◆ eof()

◆ fail()

◆ file_exist()

◆ open()

◆ operator<<()

◆ operator=()

◆ parse_array()

◆ read_array() [1/2]

◆ read_array() [2/2]

◆ read_checkpoint_assert()

◆ read_int()

◆ read_mapping_cell_count()

◆ read_mapping_count()

◆ read_mapping_info()

◆ read_vector()

◆ record_checkpoint()

◆ restore_checkpoint()

◆ write_array() [1/2]

◆ write_array() [2/2]

◆ write_checkpoint()

Member Data Documentation

◆ chkpnt

◆ current_mode

◆ F

◆ stored_chkpnt