Blue Brain BioExplorer
sonataexplorer::io::loader::SonataCacheLoader Class Reference

#include <SonataCacheLoader.h>

Inheritance diagram for sonataexplorer::io::loader::SonataCacheLoader:
Collaboration diagram for sonataexplorer::io::loader::SonataCacheLoader:

Public Member Functions

 SonataCacheLoader (core::Scene &scene, core::PropertyMap &&loaderParams={})
 
std::string getName () const final
 
strings getSupportedStorage () const final
 
bool isSupported (const std::string &storage, const std::string &extension) const final
 
core::PropertyMap getProperties () const final
 
core::ModelDescriptorPtr importFromBlob (core::Blob &&blob, const core::LoaderProgress &callback, const core::PropertyMap &properties) const final
 
core::ModelDescriptorPtr importFromStorage (const std::string &storage, const core::LoaderProgress &callback, const core::PropertyMap &properties) const final
 
void exportToFile (const core::ModelDescriptorPtr modelDescriptor, const std::string &filename)
 
- Public Member Functions inherited from core::Loader
 Loader (Scene &scene)
 
virtual ~Loader ()=default
 

Static Public Member Functions

static core::PropertyMap getCLIProperties ()
 

Additional Inherited Members

- Protected Attributes inherited from core::Loader
Scene_scene
 

Detailed Description

Load circuit from BlueConfig or CircuitConfig file, including simulation.

Definition at line 47 of file SonataCacheLoader.h.

Constructor & Destructor Documentation

◆ SonataCacheLoader()

sonataexplorer::io::loader::SonataCacheLoader::SonataCacheLoader ( core::Scene scene,
core::PropertyMap &&  loaderParams = {} 
)

Definition at line 69 of file SonataCacheLoader.cpp.

Member Function Documentation

◆ exportToFile()

void sonataexplorer::io::loader::SonataCacheLoader::exportToFile ( const core::ModelDescriptorPtr  modelDescriptor,
const std::string &  filename 
)

Definition at line 646 of file SonataCacheLoader.cpp.

◆ getCLIProperties()

PropertyMap sonataexplorer::io::loader::SonataCacheLoader::getCLIProperties ( )
static

Definition at line 978 of file SonataCacheLoader.cpp.

◆ getName()

std::string sonataexplorer::io::loader::SonataCacheLoader::getName ( ) const
finalvirtual
Returns
The loader name

Implements core::Loader.

Definition at line 75 of file SonataCacheLoader.cpp.

◆ getProperties()

PropertyMap sonataexplorer::io::loader::SonataCacheLoader::getProperties ( ) const
finalvirtual
Returns
The loader properties

Reimplemented from core::Loader.

Definition at line 973 of file SonataCacheLoader.cpp.

◆ getSupportedStorage()

std::vector< std::string > sonataexplorer::io::loader::SonataCacheLoader::getSupportedStorage ( ) const
finalvirtual
Returns
The loaders supported file extensions

Implements core::Loader.

Definition at line 80 of file SonataCacheLoader.cpp.

◆ importFromBlob()

ModelDescriptorPtr sonataexplorer::io::loader::SonataCacheLoader::importFromBlob ( core::Blob &&  blob,
const core::LoaderProgress callback,
const core::PropertyMap properties 
) const
finalvirtual

Import the data from the blob and return the created model.

Parameters
blobthe blob containing the data to import
callbackCallback for loader progress
propertiesProperties used for loading
Returns
the model that has been created by the loader

Implements core::Loader.

Definition at line 91 of file SonataCacheLoader.cpp.

◆ importFromStorage()

ModelDescriptorPtr sonataexplorer::io::loader::SonataCacheLoader::importFromStorage ( const std::string &  storage,
const core::LoaderProgress callback,
const core::PropertyMap properties 
) const
finalvirtual

Import the data from the given file or database schema and return the created model.

Parameters
storagethe file or database schema containing the data to import
callbackCallback for loader progress
propertiesProperties used for loading
Returns
the model that has been created by the loader

Implements core::Loader.

Definition at line 107 of file SonataCacheLoader.cpp.

◆ isSupported()

bool sonataexplorer::io::loader::SonataCacheLoader::isSupported ( const std::string &  filename,
const std::string &  extension 
) const
finalvirtual

Query the loader if it can load the given file

Implements core::Loader.

Definition at line 85 of file SonataCacheLoader.cpp.


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