sonataexplorer::neuroscience::neuron::VoltageSimulationHandler Class Reference

The VoltageSimulationHandler class handles simulation frames for the current circuit. Frames are stored in a memory mapped file that is accessed according to a specified timestamp. The VoltageSimulationHandler class is in charge of keeping the handle to the memory mapped file. More...

#include <VoltageSimulationHandler.h>

Inheritance diagram for sonataexplorer::neuroscience::neuron::VoltageSimulationHandler:

Collaboration diagram for sonataexplorer::neuroscience::neuron::VoltageSimulationHandler:

Public Member Functions
	VoltageSimulationHandler (const std::string &reportPath, const brion::GIDSet &gids, const bool synchronousMode=false)
	Default constructor. More...
	VoltageSimulationHandler (const VoltageSimulationHandler &rhs)
	~VoltageSimulationHandler ()
void *	getFrameData (const uint32_t frame) final
	returns a void pointer to the simulation data for the given frame or nullptr if the frame is not loaded yet. More...
const std::string &	getReportPath () const
common::CompartmentReportPtr	getReport () const
bool	isSynchronized () const
bool	isReady () const final
core::AbstractSimulationHandlerPtr	clone () const final
Public Member Functions inherited from core::AbstractSimulationHandler
virtual	~AbstractSimulationHandler ()
AbstractSimulationHandler &	operator= (const AbstractSimulationHandler &rhs)
virtual PLATFORM_API void	bind (const MaterialPtr &)
virtual PLATFORM_API void	unbind (const MaterialPtr &)
uint32_t	getCurrentFrame () const
uint64_t	getFrameSize () const
	getFrameSize return the size of the current simulation frame More...
void	setFrameSize (const uint64_t frameSize)
	setFrameSize Sets the size of the current simulation frame More...
uint32_t	getNbFrames () const
	getNbFrames returns the number of frame for the current simulation More...
void	setNbFrames (const uint32_t nbFrames)
	setNbFrames sets the number of frame for the current simulation More...
double	getDt () const
const std::string &	getUnit () const
virtual void	waitReady () const

Additional Inherited Members
Protected Member Functions inherited from core::AbstractSimulationHandler
uint32_t	_getBoundedFrame (const uint32_t frame) const
Protected Attributes inherited from core::AbstractSimulationHandler
uint32_t	_currentFrame {std::numeric_limits<uint32_t>::max()}
uint32_t	_nbFrames {0}
uint64_t	_frameSize {0}
double	_dt {0}
std::string	_unit
floats	_frameData

Detailed Description

The VoltageSimulationHandler class handles simulation frames for the current circuit. Frames are stored in a memory mapped file that is accessed according to a specified timestamp. The VoltageSimulationHandler class is in charge of keeping the handle to the memory mapped file.

Definition at line 45 of file VoltageSimulationHandler.h.

Constructor & Destructor Documentation

VoltageSimulationHandler() [1/2]

sonataexplorer::neuroscience::neuron::VoltageSimulationHandler::VoltageSimulationHandler	(	const std::string &	reportPath,
		const brion::GIDSet &	gids,
		const bool	synchronousMode = false
	)

Default constructor.

Parameters

geometryParameters	Geometry parameters
reportSource	path to report source
gids	GIDS to load

Definition at line 37 of file VoltageSimulationHandler.cpp.

VoltageSimulationHandler() [2/2]

sonataexplorer::neuroscience::neuron::VoltageSimulationHandler::VoltageSimulationHandler

(

const VoltageSimulationHandler &

rhs

)

Definition at line 64 of file VoltageSimulationHandler.cpp.

~VoltageSimulationHandler()

sonataexplorer::neuroscience::neuron::VoltageSimulationHandler::~VoltageSimulationHandler

(

)

Definition at line 72 of file VoltageSimulationHandler.cpp.

Member Function Documentation

clone()

AbstractSimulationHandlerPtr sonataexplorer::neuroscience::neuron::VoltageSimulationHandler::clone ( ) const

finalvirtual

Returns

a clone of the concrete simulation handler implementation.

Implements core::AbstractSimulationHandler.

Definition at line 74 of file VoltageSimulationHandler.cpp.

getFrameData()

void * sonataexplorer::neuroscience::neuron::VoltageSimulationHandler::getFrameData ( const uint32_t  frame )

finalvirtual

returns a void pointer to the simulation data for the given frame or nullptr if the frame is not loaded yet.

Reimplemented from core::AbstractSimulationHandler.

Definition at line 84 of file VoltageSimulationHandler.cpp.

getReport()

common::CompartmentReportPtr sonataexplorer::neuroscience::neuron::VoltageSimulationHandler::getReport ( ) const

inline

Definition at line 62 of file VoltageSimulationHandler.h.

getReportPath()

const std::string& sonataexplorer::neuroscience::neuron::VoltageSimulationHandler::getReportPath ( ) const

inline

Definition at line 61 of file VoltageSimulationHandler.h.

isReady()

bool sonataexplorer::neuroscience::neuron::VoltageSimulationHandler::isReady ( ) const

finalvirtual

Returns

true if the requested frame from getFrameData() is ready to consume and if it is allowed to advance to the next frame.

Reimplemented from core::AbstractSimulationHandler.

Definition at line 79 of file VoltageSimulationHandler.cpp.

isSynchronized()

bool sonataexplorer::neuroscience::neuron::VoltageSimulationHandler::isSynchronized ( ) const

inline

Definition at line 63 of file VoltageSimulationHandler.h.

---

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

• bioexplorer/backend/plugins/Sonata/plugin/neuroscience/neuron/VoltageSimulationHandler.h
• bioexplorer/backend/plugins/Sonata/plugin/neuroscience/neuron/VoltageSimulationHandler.cpp