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

categoryName

std::string sofa::core::ComponentLibrary::categoryName

protected

description

std::string sofa::core::ComponentLibrary::description

protected

entry

ClassEntry::SPtr sofa::core::ComponentLibrary::entry

protected

name

std::string sofa::core::ComponentLibrary::name

protected

templateName

std::vector< std::string > sofa::core::ComponentLibrary::templateName

protected

Constructor details

ComponentLibrary()

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

~ComponentLibrary()

virtual sofa::core::ComponentLibrary::~ComponentLibrary ( )

inlinevirtual

Function details

addTemplate()

void sofa::core::ComponentLibrary::addTemplate ( const std::string &  templateName )

virtual

endConstruction()

void sofa::core::ComponentLibrary::endConstruction ( )

virtual

getCategory()

const std::string& sofa::core::ComponentLibrary::getCategory ( ) const

inline

getDescription()

const std::string& sofa::core::ComponentLibrary::getDescription ( ) const

inline

getEntry()

const ClassEntry::SPtr sofa::core::ComponentLibrary::getEntry ( ) const

inline

getName()

const std::string& sofa::core::ComponentLibrary::getName ( ) const

inline

getTemplates()

const std::vector< std::string >& sofa::core::ComponentLibrary::getTemplates ( ) const

inline

setDisplayed()

virtual void sofa::core::ComponentLibrary::setDisplayed ( bool  )

inlinevirtual