#include <CellMLLoader.hpp>

Collaboration diagram for CellMLLoader:

Public Member Functions
	CellMLLoader (const FileFinder &rCellMLFile, const OutputFileHandler &rOutputFileHandler, const std::vector< std::string > &rOptions)
boost::shared_ptr < AbstractCardiacCell >	LoadCardiacCell (void)
boost::shared_ptr < AbstractCvodeCell >	LoadCvodeCell (void)
Private Member Functions
AbstractCardiacCellInterface *	LoadCellMLFile (bool makeCvodeCell)
Private Attributes
FileFinder	mCellMLFile
OutputFileHandler	mOutputFileHandler
std::vector< std::string >	mOptions
boost::shared_ptr < CellMLToSharedLibraryConverter >	mpConverter
boost::logic::tribool	mUseCvode

Detailed Description

A helper class which will dynamically load a CellML file and provide a method to get a pointer to a new AbstractCardiacCell (or AbstractCvodeCell if CVODE is enabled).

Note that you cannot call both LoadCardiacCell and LoadCvodeCell on the same object, since there would be filename conflicts trying to create different classes in the same output folder. Create a second loader with a different rOutputFileHandler parameter if you need both kinds of cell.

Definition at line 58 of file CellMLLoader.hpp.

Constructor & Destructor Documentation

CellMLLoader::CellMLLoader	(	const FileFinder &	rCellMLFile,
		const OutputFileHandler &	rOutputFileHandler,
		const std::vector< std::string > &	rOptions
	)

Create a new loader for a CellML model.

Parameters:

rCellMLFile	the location of a CellML file to load on the fly
rOutputFileHandler	where to put the generated files
rOptions	any options to be passed to PyCML e.g. "--expose-annotated-variables"

Definition at line 41 of file CellMLLoader.cpp.

Member Function Documentation

boost::shared_ptr< AbstractCardiacCell > CellMLLoader::LoadCardiacCell ( void )

Make an AbstractCardiacCell, which will be solved with a (Forward)Euler solver, and uses the default stimulus from the CellML file (if present).

Returns:: a pointer to the cell

Definition at line 102 of file CellMLLoader.cpp.

References LoadCellMLFile().

AbstractCardiacCellInterface * CellMLLoader::LoadCellMLFile ( bool makeCvodeCell ) [private]

A method to make a new cell model which is then cast in the public methods to the relevant type. It copies the CellML file to the mOutputFileHandler location, writes an options file, converts to .hpp and .cpp, makes a shared library, and loads the cell.

Note that on any subsequent calls, the shared library will already exist, and so the conversion will not be performed, making the method much faster.

Parameters:

makeCvodeCell whether this cell should be an AbstractCvodeCell (false = AbstractCardiacCell)