Blue Brain BioExplorer
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
core::AbstractSimulationHandler Class Referenceabstract

The AbstractSimulationHandler class handles simulation frames for the current circuit. More...

#include <AbstractSimulationHandler.h>

Inheritance diagram for core::AbstractSimulationHandler:
Inheritance graph
[legend]

Public Member Functions

virtual AbstractSimulationHandlerPtr clone () const =0
 
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
 
virtual void * getFrameData (uint32_t frame)
 returns a void pointer to the simulation data for the given frame or nullptr if the frame is not loaded yet. More...
 
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
 

Protected Member Functions

uint32_t _getBoundedFrame (const uint32_t frame) const
 

Protected Attributes

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 AbstractSimulationHandler class handles simulation frames for the current circuit.

Definition at line 32 of file AbstractSimulationHandler.h.

Constructor & Destructor Documentation

◆ ~AbstractSimulationHandler()

core::AbstractSimulationHandler::~AbstractSimulationHandler ( )
virtualdefault

Member Function Documentation

◆ _getBoundedFrame()

uint32_t core::AbstractSimulationHandler::_getBoundedFrame ( const uint32_t  frame) const
protected

Definition at line 42 of file AbstractSimulationHandler.cpp.

◆ bind()

virtual PLATFORM_API void core::AbstractSimulationHandler::bind ( const MaterialPtr &  )
inlinevirtual

Definition at line 42 of file AbstractSimulationHandler.h.

◆ clone()

virtual AbstractSimulationHandlerPtr core::AbstractSimulationHandler::clone ( ) const
pure virtual
Returns
a clone of the concrete simulation handler implementation.

Implemented in bioexplorer::vasculature::VasculatureHandler, bioexplorer::morphology::SpikeSimulationHandler, bioexplorer::morphology::SomaSimulationHandler, bioexplorer::morphology::CompartmentSimulationHandler, bioexplorer::connectomics::SynapseEfficacySimulationHandler, sonataexplorer::neuroscience::neuron::VoltageSimulationHandler, sonataexplorer::neuroscience::neuron::SpikeSimulationHandler, sonataexplorer::neuroscience::neuron::MEGHandler, sonataexplorer::neuroscience::neuron::CellGrowthHandler, and bioexplorer::metabolism::MetabolismHandler.

◆ getCurrentFrame()

uint32_t core::AbstractSimulationHandler::getCurrentFrame ( ) const
inline
Returns
the current loaded frame for the simulation.

Definition at line 47 of file AbstractSimulationHandler.h.

◆ getDt()

double core::AbstractSimulationHandler::getDt ( ) const
inline
Returns
the dt of the simulation in getUnit() time unit; 0 if not reported

Definition at line 74 of file AbstractSimulationHandler.h.

◆ getFrameData()

virtual void* core::AbstractSimulationHandler::getFrameData ( uint32_t  frame)
inlinevirtual

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

Reimplemented in bioexplorer::vasculature::VasculatureHandler, sonataexplorer::neuroscience::neuron::MEGHandler, sonataexplorer::neuroscience::neuron::CellGrowthHandler, bioexplorer::metabolism::MetabolismHandler, bioexplorer::morphology::SpikeSimulationHandler, bioexplorer::morphology::SomaSimulationHandler, bioexplorer::morphology::CompartmentSimulationHandler, bioexplorer::connectomics::SynapseEfficacySimulationHandler, sonataexplorer::neuroscience::neuron::VoltageSimulationHandler, and sonataexplorer::neuroscience::neuron::SpikeSimulationHandler.

Definition at line 52 of file AbstractSimulationHandler.h.

◆ getFrameSize()

uint64_t core::AbstractSimulationHandler::getFrameSize ( ) const
inline

getFrameSize return the size of the current simulation frame

Definition at line 57 of file AbstractSimulationHandler.h.

◆ getNbFrames()

uint32_t core::AbstractSimulationHandler::getNbFrames ( ) const
inline

getNbFrames returns the number of frame for the current simulation

Definition at line 65 of file AbstractSimulationHandler.h.

◆ getUnit()

const std::string& core::AbstractSimulationHandler::getUnit ( ) const
inline
Returns
the time unit of the simulation; empty if not reported.

Definition at line 76 of file AbstractSimulationHandler.h.

◆ isReady()

virtual bool core::AbstractSimulationHandler::isReady ( ) const
inlinevirtual
Returns
true if the requested frame from getFrameData() is ready to consume and if it is allowed to advance to the next frame.

Reimplemented in bioexplorer::vasculature::VasculatureHandler, sonataexplorer::neuroscience::neuron::VoltageSimulationHandler, sonataexplorer::neuroscience::neuron::MEGHandler, sonataexplorer::neuroscience::neuron::CellGrowthHandler, and bioexplorer::metabolism::MetabolismHandler.

Definition at line 79 of file AbstractSimulationHandler.h.

◆ operator=()

AbstractSimulationHandler & core::AbstractSimulationHandler::operator= ( const AbstractSimulationHandler &  rhs)

Definition at line 27 of file AbstractSimulationHandler.cpp.

◆ setFrameSize()

void core::AbstractSimulationHandler::setFrameSize ( const uint64_t  frameSize)
inline

setFrameSize Sets the size of the current simulation frame

Definition at line 61 of file AbstractSimulationHandler.h.

◆ setNbFrames()

void core::AbstractSimulationHandler::setNbFrames ( const uint32_t  nbFrames)
inline

setNbFrames sets the number of frame for the current simulation

Definition at line 69 of file AbstractSimulationHandler.h.

◆ unbind()

virtual PLATFORM_API void core::AbstractSimulationHandler::unbind ( const MaterialPtr &  )
inlinevirtual

Definition at line 44 of file AbstractSimulationHandler.h.

◆ waitReady()

virtual void core::AbstractSimulationHandler::waitReady ( ) const
inlinevirtual

Wait until current frame is ready

Definition at line 81 of file AbstractSimulationHandler.h.

Member Data Documentation

◆ _currentFrame

uint32_t core::AbstractSimulationHandler::_currentFrame {std::numeric_limits<uint32_t>::max()}
protected

Definition at line 86 of file AbstractSimulationHandler.h.

◆ _dt

double core::AbstractSimulationHandler::_dt {0}
protected

Definition at line 89 of file AbstractSimulationHandler.h.

◆ _frameData

floats core::AbstractSimulationHandler::_frameData
protected

Definition at line 92 of file AbstractSimulationHandler.h.

◆ _frameSize

uint64_t core::AbstractSimulationHandler::_frameSize {0}
protected

Definition at line 88 of file AbstractSimulationHandler.h.

◆ _nbFrames

uint32_t core::AbstractSimulationHandler::_nbFrames {0}
protected

Definition at line 87 of file AbstractSimulationHandler.h.

◆ _unit

std::string core::AbstractSimulationHandler::_unit
protected

Definition at line 90 of file AbstractSimulationHandler.h.

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