Blue Brain BioExplorer
bioexplorer::metabolism::MetabolismHandler Class Reference

The MetabolismHandler class handles metabolite concentrations. More...

#include <MetabolismHandler.h>

Inheritance diagram for bioexplorer::metabolism::MetabolismHandler:
Collaboration diagram for bioexplorer::metabolism::MetabolismHandler:

Public Member Functions

 MetabolismHandler ()
 Default constructor. More...
 
 MetabolismHandler (const CommandLineArguments &args)
 
 MetabolismHandler (const AttachHandlerDetails &payload)
 
 MetabolismHandler (const MetabolismHandler &rhs)
 
 ~MetabolismHandler ()
 
void * getFrameData (const uint32_t) final
 returns a void pointer to the simulation data for the given frame or nullptr if the frame is not loaded yet. More...
 
bool isReady () const final
 
core::AbstractSimulationHandlerPtr clone () const final
 
void setMetaboliteIds (const int32_ts &metaboliteIds)
 
- 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 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 MetabolismHandler class handles metabolite concentrations.

Definition at line 39 of file MetabolismHandler.h.

Constructor & Destructor Documentation

◆ MetabolismHandler() [1/4]

bioexplorer::metabolism::MetabolismHandler::MetabolismHandler ( )

Default constructor.

Definition at line 35 of file MetabolismHandler.cpp.

◆ MetabolismHandler() [2/4]

bioexplorer::metabolism::MetabolismHandler::MetabolismHandler ( const CommandLineArguments args)

Definition at line 44 of file MetabolismHandler.cpp.

◆ MetabolismHandler() [3/4]

bioexplorer::metabolism::MetabolismHandler::MetabolismHandler ( const AttachHandlerDetails payload)

Definition at line 53 of file MetabolismHandler.cpp.

◆ MetabolismHandler() [4/4]

bioexplorer::metabolism::MetabolismHandler::MetabolismHandler ( const MetabolismHandler rhs)

Definition at line 74 of file MetabolismHandler.cpp.

◆ ~MetabolismHandler()

bioexplorer::metabolism::MetabolismHandler::~MetabolismHandler ( )

Definition at line 79 of file MetabolismHandler.cpp.

Member Function Documentation

◆ clone()

AbstractSimulationHandlerPtr bioexplorer::metabolism::MetabolismHandler::clone ( ) const
finalvirtual
Returns
a clone of the concrete simulation handler implementation.

Implements core::AbstractSimulationHandler.

Definition at line 108 of file MetabolismHandler.cpp.

◆ getFrameData()

void * bioexplorer::metabolism::MetabolismHandler::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 MetabolismHandler.cpp.

◆ isReady()

bool bioexplorer::metabolism::MetabolismHandler::isReady ( ) const
inlinefinalvirtual
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 54 of file MetabolismHandler.h.

◆ setMetaboliteIds()

void bioexplorer::metabolism::MetabolismHandler::setMetaboliteIds ( const int32_ts metaboliteIds)
inline

Definition at line 58 of file MetabolismHandler.h.


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