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

#include <SofaLibrary.h>

An Generic Library. More...

Detailed Description

An Generic Library.

It reads the content of the Object Factory and builds a library of components sorted inside categories. This Interface is used for the Modeler mainly.

Protected Attributes

VecCategory categories
 
std::vector< std::string > exampleFiles
 
unsigned int numComponents
 

Public Member Functions

virtual ~SofaLibrary ()
 
virtual void build (const std::vector< std::string > &examples=std::vector< std::string >())
 
virtual void clear ()
 
std::string getComponentDescription (const std::string &componentName) const
 
const VecCategorygetCategories () const
 
const CategoryLibrarygetCategory (const std::string &categoryName) const
 
const ComponentLibrarygetComponent (const std::string &componentName) const
 
unsigned int getNumComponents () const
 

Protected Member Functions

virtual CategoryLibrarycreateCategory (const std::string &category, unsigned int)
 
virtual void addCategory (CategoryLibrary *)
 
void computeNumComponents ()
 

Attribute details

VecCategory sofa::core::SofaLibrary::categories
protected
std::vector< std::string > sofa::core::SofaLibrary::exampleFiles
protected
unsigned int sofa::core::SofaLibrary::numComponents
protected

Constructor details

virtual sofa::core::SofaLibrary::~SofaLibrary ( )
inlinevirtual

Function details

void sofa::core::SofaLibrary::addCategory ( CategoryLibrary category)
protectedvirtual
void sofa::core::SofaLibrary::build ( const std::vector< std::string > &  examples = std::vector< std::string >())
virtual
void sofa::core::SofaLibrary::clear ( )
virtual
void sofa::core::SofaLibrary::computeNumComponents ( )
protected
virtual CategoryLibrary* sofa::core::SofaLibrary::createCategory ( const std::string &  category,
unsigned  int 
)
inlineprotectedvirtual
const VecCategory& sofa::core::SofaLibrary::getCategories ( ) const
inline
const CategoryLibrary * sofa::core::SofaLibrary::getCategory ( const std::string &  categoryName) const
const ComponentLibrary * sofa::core::SofaLibrary::getComponent ( const std::string &  componentName) const
std::string sofa::core::SofaLibrary::getComponentDescription ( const std::string &  componentName) const
unsigned int sofa::core::SofaLibrary::getNumComponents ( ) const
inline