SOFA API  3944ba52
Open source framework for multi-physics simuation
sofa::core::ComponentLibrary Class Reference

#include <ComponentLibrary.h>

An Generic Component of the Sofa Library. More...

Detailed Description

An Generic Component of the Sofa Library.

It contains all the information related to a Sofa component: its name, the templates available, a description of it, its creator, ... This Interface is used for the Modeler mainly.

Protected Attributes

std::string name
 
std::vector< std::string > templateName
 
std::string description
 
std::string categoryName
 
ClassEntry::SPtr entry
 

Public Member Functions

 ComponentLibrary (const std::string &componentName, const std::string &categoryName, ClassEntry::SPtr entry, const std::vector< std::string > &exampleFiles)
 
virtual ~ComponentLibrary ()
 
virtual void addTemplate (const std::string &templateName)
 
virtual void endConstruction ()
 
virtual void setDisplayed (bool)
 
const std::string & getName () const
 
const std::string & getDescription () const
 
const std::string & getCategory () const
 
const std::vector< std::string > & getTemplates () const
 
const ClassEntry::SPtr getEntry () const
 

Attribute details

std::string sofa::core::ComponentLibrary::categoryName
protected
std::string sofa::core::ComponentLibrary::description
protected
ClassEntry::SPtr sofa::core::ComponentLibrary::entry
protected
std::string sofa::core::ComponentLibrary::name
protected
std::vector< std::string > sofa::core::ComponentLibrary::templateName
protected

Constructor details

sofa::core::ComponentLibrary::ComponentLibrary ( const std::string &  componentName,
const std::string &  categoryName,
ClassEntry::SPtr  entry,
const std::vector< std::string > &  exampleFiles 
)
virtual sofa::core::ComponentLibrary::~ComponentLibrary ( )
inlinevirtual

Function details

void sofa::core::ComponentLibrary::addTemplate ( const std::string &  templateName)
virtual
void sofa::core::ComponentLibrary::endConstruction ( )
virtual
const std::string& sofa::core::ComponentLibrary::getCategory ( ) const
inline
const std::string& sofa::core::ComponentLibrary::getDescription ( ) const
inline
const ClassEntry::SPtr sofa::core::ComponentLibrary::getEntry ( ) const
inline
const std::string& sofa::core::ComponentLibrary::getName ( ) const
inline
const std::vector< std::string >& sofa::core::ComponentLibrary::getTemplates ( ) const
inline
virtual void sofa::core::ComponentLibrary::setDisplayed ( bool  )
inlinevirtual