SOFA API  014b24ea
Open source framework for multi-physics simuation
sofa::core::Plugin::RegisterObject Class Reference

#include <Plugin.h>

Public Member Functions

 RegisterObject (sofa::core::Plugin &plugin, const std::string &description)
 Start the registration by giving the description of this class. More...
 
RegisterObjectaddAlias (std::string val)
 Add an alias name for this class. More...
 
RegisterObjectaddDescription (std::string val)
 Add more descriptive text about this class. More...
 
RegisterObjectaddAuthor (std::string val)
 Specify a list of authors (separated with spaces) More...
 
RegisterObjectaddLicense (std::string val)
 Specify a license (LGPL, GPL, ...) More...
 
template<class Component >
RegisterObjectadd (bool isDefault=false)
 
 operator int ()
 

Constructor details

sofa::core::Plugin::RegisterObject::RegisterObject ( sofa::core::Plugin plugin,
const std::string &  description 
)
inline

Start the registration by giving the description of this class.

Function details

template<class Component >
RegisterObject& sofa::core::Plugin::RegisterObject::add ( bool  isDefault = false)
inline

Add a template instanciation of this class.

Parameters
isDefaultset to true if this should be the default instance when no template name is given.
RegisterObject& sofa::core::Plugin::RegisterObject::addAlias ( std::string  val)
inline

Add an alias name for this class.

RegisterObject& sofa::core::Plugin::RegisterObject::addAuthor ( std::string  val)
inline

Specify a list of authors (separated with spaces)

RegisterObject& sofa::core::Plugin::RegisterObject::addDescription ( std::string  val)
inline

Add more descriptive text about this class.

RegisterObject& sofa::core::Plugin::RegisterObject::addLicense ( std::string  val)
inline

Specify a license (LGPL, GPL, ...)

sofa::core::Plugin::RegisterObject::operator int ( )
inline