The CellGrowthHandler class handles distance to the soma. More...

#include <CellGrowthHandler.h>

Inheritance diagram for sonataexplorer::neuroscience::neuron::CellGrowthHandler:

Collaboration diagram for sonataexplorer::neuroscience::neuron::CellGrowthHandler:

Public Member Functions
	CellGrowthHandler (const uint32_t nbFrames)
	Default constructor. More...

	CellGrowthHandler (const CellGrowthHandler &rhs)

	~CellGrowthHandler ()

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

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 CellGrowthHandler class handles distance to the soma.

Definition at line 39 of file CellGrowthHandler.h.

Constructor & Destructor Documentation

◆ CellGrowthHandler() [1/2]

sonataexplorer::neuroscience::neuron::CellGrowthHandler::CellGrowthHandler ( const uint32_t nbFrames )

Default constructor.

Definition at line 31 of file CellGrowthHandler.cpp.

◆ CellGrowthHandler() [2/2]

sonataexplorer::neuroscience::neuron::CellGrowthHandler::CellGrowthHandler ( const CellGrowthHandler & rhs )

Definition at line 41 of file CellGrowthHandler.cpp.

◆ ~CellGrowthHandler()

sonataexplorer::neuroscience::neuron::CellGrowthHandler::~CellGrowthHandler ( )

Definition at line 46 of file CellGrowthHandler.cpp.

Member Function Documentation

◆ clone()

core::AbstractSimulationHandlerPtr sonataexplorer::neuroscience::neuron::CellGrowthHandler::clone ( ) const

finalvirtual

Returns: a clone of the concrete simulation handler implementation.

Implements core::AbstractSimulationHandler.

Definition at line 60 of file CellGrowthHandler.cpp.

◆ getFrameData()

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

◆ isReady()

bool sonataexplorer::neuroscience::neuron::CellGrowthHandler::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.