Blue Brain BioExplorer
sonataexplorer::neuroscience::neuron::SpikeSimulationHandler Class Reference

#include <SpikeSimulationHandler.h>

Inheritance diagram for sonataexplorer::neuroscience::neuron::SpikeSimulationHandler:
Collaboration diagram for sonataexplorer::neuroscience::neuron::SpikeSimulationHandler:

Public Member Functions

 SpikeSimulationHandler (const std::string &reportPath, const brain::GIDSet &gids)
 
 SpikeSimulationHandler (const SpikeSimulationHandler &rhs)
 
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
 
SpikeReportReaderPtr getReport () const
 
const brain::GIDSet & getGIDs () const
 
core::AbstractSimulationHandlerPtr clone () const final
 
void setVisualizationSettings (const double restVoltage, const double spikingVoltage, const double timeInterval, const double decaySpeed)
 
- Public Member Functions inherited from core::AbstractSimulationHandler
virtual ~AbstractSimulationHandler ()
 
AbstractSimulationHandleroperator= (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 bool isReady () 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

Definition at line 39 of file SpikeSimulationHandler.h.

Constructor & Destructor Documentation

◆ SpikeSimulationHandler() [1/2]

sonataexplorer::neuroscience::neuron::SpikeSimulationHandler::SpikeSimulationHandler ( const std::string &  reportPath,
const brain::GIDSet &  gids 
)

◆ SpikeSimulationHandler() [2/2]

sonataexplorer::neuroscience::neuron::SpikeSimulationHandler::SpikeSimulationHandler ( const SpikeSimulationHandler rhs)

Definition at line 73 of file SpikeSimulationHandler.cpp.

Member Function Documentation

◆ clone()

AbstractSimulationHandlerPtr sonataexplorer::neuroscience::neuron::SpikeSimulationHandler::clone ( ) const
finalvirtual
Returns
a clone of the concrete simulation handler implementation.

Implements core::AbstractSimulationHandler.

Definition at line 108 of file SpikeSimulationHandler.cpp.

◆ getFrameData()

void * sonataexplorer::neuroscience::neuron::SpikeSimulationHandler::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 82 of file SpikeSimulationHandler.cpp.

◆ getGIDs()

const brain::GIDSet& sonataexplorer::neuroscience::neuron::SpikeSimulationHandler::getGIDs ( ) const
inline

Definition at line 49 of file SpikeSimulationHandler.h.

◆ getReport()

SpikeReportReaderPtr sonataexplorer::neuroscience::neuron::SpikeSimulationHandler::getReport ( ) const
inline

Definition at line 48 of file SpikeSimulationHandler.h.

◆ getReportPath()

const std::string& sonataexplorer::neuroscience::neuron::SpikeSimulationHandler::getReportPath ( ) const
inline

Definition at line 47 of file SpikeSimulationHandler.h.

◆ setVisualizationSettings()

void sonataexplorer::neuroscience::neuron::SpikeSimulationHandler::setVisualizationSettings ( const double  restVoltage,
const double  spikingVoltage,
const double  timeInterval,
const double  decaySpeed 
)

Definition at line 113 of file SpikeSimulationHandler.cpp.


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