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::ModuleTemplate Class Reference

#include <ModuleTemplate.hpp>

Public Member Functions

std::string GetFullID () const
 
 ModuleTemplate (ModuleCollection &collection)
 
 ModuleTemplate (ModuleCollection &collection, rapidxml::xml_node< char > *node)
 

Public Attributes

std::string class_name
 
ModuleCollectioncollection
 
std::string description = ""
 
std::string guitree = ""
 
std::string guitype = ""
 
bool has_class = false
 
bool has_sc_code = false
 
std::string id
 
std::list< IOLetTemplateinlets
 
std::string name
 
std::list< IOLetTemplateoutlets
 
std::list< std::shared_ptr
< ParamTemplate > > 
params
 
std::list< std::pair
< std::string, std::string > > 
replies
 
std::string sc_code
 

Detailed Description

All modules are build according to a template. If multiple instances of the same module type are present, they will share a single instance of ModuleTemplate. ModuleTemplate contains all data about a module that are loaded from the module description file. The fields are self-explainatory.

Constructor & Destructor Documentation

AlgAudio::ModuleTemplate::ModuleTemplate ( ModuleCollection collection)
AlgAudio::ModuleTemplate::ModuleTemplate ( ModuleCollection collection,
rapidxml::xml_node< char > *  node 
)

Member Function Documentation

std::string AlgAudio::ModuleTemplate::GetFullID ( ) const

Member Data Documentation

std::string AlgAudio::ModuleTemplate::class_name
ModuleCollection& AlgAudio::ModuleTemplate::collection
std::string AlgAudio::ModuleTemplate::description = ""
std::string AlgAudio::ModuleTemplate::guitree = ""
std::string AlgAudio::ModuleTemplate::guitype = ""
bool AlgAudio::ModuleTemplate::has_class = false
bool AlgAudio::ModuleTemplate::has_sc_code = false
std::string AlgAudio::ModuleTemplate::id
std::list<IOLetTemplate> AlgAudio::ModuleTemplate::inlets
std::string AlgAudio::ModuleTemplate::name
std::list<IOLetTemplate> AlgAudio::ModuleTemplate::outlets
std::list<std::shared_ptr<ParamTemplate> > AlgAudio::ModuleTemplate::params
std::list<std::pair<std::string, std::string> > AlgAudio::ModuleTemplate::replies
std::string AlgAudio::ModuleTemplate::sc_code

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