Blue Brain BioExplorer
bioexplorer::morphology::CompartmentSimulationHandler Class Reference

The CompartmentSimulationHandler handles the reading of simulation information from the database at a compartment level. When attached to a model, the simulation data is communicated to the renderer by Core, and mapped to the geometry by the BioExplorer advanced renderer. More...

#include <CompartmentSimulationHandler.h>

Inheritance diagram for bioexplorer::morphology::CompartmentSimulationHandler:
Collaboration diagram for bioexplorer::morphology::CompartmentSimulationHandler:

Public Member Functions

 CompartmentSimulationHandler (const std::string &populationName, const uint64_t simulationReportId)
 
 CompartmentSimulationHandler (const CompartmentSimulationHandler &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...
 
core::AbstractSimulationHandlerPtr clone () const final
 
- 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

The CompartmentSimulationHandler handles the reading of simulation information from the database at a compartment level. When attached to a model, the simulation data is communicated to the renderer by Core, and mapped to the geometry by the BioExplorer advanced renderer.

Definition at line 40 of file CompartmentSimulationHandler.h.

Constructor & Destructor Documentation

◆ CompartmentSimulationHandler() [1/2]

bioexplorer::morphology::CompartmentSimulationHandler::CompartmentSimulationHandler ( const std::string &  populationName,
const uint64_t  simulationReportId 
)

Definition at line 45 of file CompartmentSimulationHandler.cpp.

◆ CompartmentSimulationHandler() [2/2]

bioexplorer::morphology::CompartmentSimulationHandler::CompartmentSimulationHandler ( const CompartmentSimulationHandler rhs)

Definition at line 74 of file CompartmentSimulationHandler.cpp.

Member Function Documentation

◆ clone()

core::AbstractSimulationHandlerPtr bioexplorer::morphology::CompartmentSimulationHandler::clone ( ) const
finalvirtual

Returns
a clone of the concrete simulation handler implementation.

Implements core::AbstractSimulationHandler.

Definition at line 95 of file CompartmentSimulationHandler.cpp.

◆ getFrameData()

void * bioexplorer::morphology::CompartmentSimulationHandler::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 81 of file CompartmentSimulationHandler.cpp.


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