libAlgAudio  v1.99-440-g08538e5-dirty
The development library for AlgAudio framework.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
AlgAudio::ModuleCollection Class Reference

#include <ModuleCollection.hpp>

Public Member Functions

std::shared_ptr< ModuleTemplateGetTemplateByID (std::string id)
 
LateReturn InstallAllTemplatesIntoSC ()
 
 ModuleCollection (std::ifstream &file, std::string basedir)
 

Public Attributes

std::string basedir
 
std::shared_ptr< LibLoaderdefaultlib
 
std::string defaultlib_path
 
bool has_defaultlib
 
std::string id
 
std::string name
 
std::map< std::string,
std::shared_ptr
< ModuleTemplate > > 
templates_by_id
 

Detailed Description

A module collection represents a set of module templates from as single module description file.

Constructor & Destructor Documentation

AlgAudio::ModuleCollection::ModuleCollection ( std::ifstream &  file,
std::string  basedir 
)

Member Function Documentation

std::shared_ptr<ModuleTemplate> AlgAudio::ModuleCollection::GetTemplateByID ( std::string  id)
Parameters
idThe requested module template id.
Returns
a shared_ptr to template with the requested id, or a nullptr if no match is found.
LateReturn AlgAudio::ModuleCollection::InstallAllTemplatesIntoSC ( )

Member Data Documentation

std::string AlgAudio::ModuleCollection::basedir
std::shared_ptr<LibLoader> AlgAudio::ModuleCollection::defaultlib
std::string AlgAudio::ModuleCollection::defaultlib_path
bool AlgAudio::ModuleCollection::has_defaultlib
std::string AlgAudio::ModuleCollection::id
std::string AlgAudio::ModuleCollection::name
std::map<std::string, std::shared_ptr<ModuleTemplate> > AlgAudio::ModuleCollection::templates_by_id

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