#include <BaseComponent.h>

Base class for simulation components. More...

Inheritance diagram for sofa::core::objectmodel::BaseComponent:

Detailed Description

Base class for simulation components.

An object defines a part of the functionality in the simulation (stores state data, specify topology, compute forces, etc). Each simulation object is related to a context, which gives access to all available external data. It is able to process events, if listening enabled (default is false).

Protected Attributes
SingleLink< BaseComponent, BaseContext, BaseLink::FLAG_DOUBLELINK >	l_context

LinkSlaves	l_slaves

SingleLink< BaseComponent, BaseComponent, BaseLink::FLAG_DOUBLELINK >	l_master

Protected Attributes inherited from sofa::core::objectmodel::Base
std::map< std::string, sofa::core::DataTrackerCallback >	m_internalEngine

VecData	m_vecData
	List of fields (Data instances) More...

MapData	m_aliasData
	name -> Data multi-map (includes names and aliases) More...

VecLink	m_vecLink
	List of links. More...

MapLink	m_aliasLink
	name -> Link multi-map (includes names and aliases) More...

Public Member Functions
	SOFA_CLASS (BaseComponent, Base)

virtual void	draw (const core::visual::VisualParams *)
	Render internal data of this object, for debugging purposes. More...

virtual void	computeBBox (const core::ExecParams *, bool=false)

void	setSrc (const std::string &v, std::vector< std::string > *attributeList=nullptr)
	Sets a source Object and parses it to collect dependent Data. More...

void	setSrc (const std::string &v, const BaseComponent loader, std::vector< std::string > attributeList=nullptr)

Base *	findLinkDestClass (const BaseClass destType, const std::string &path, const BaseLink link) override

virtual std::string	getPathName () const override
	Return the full path name of this object. More...

virtual bool	insertInNode (BaseNode *)

virtual bool	removeInNode (BaseNode *)

data access
Access to external data
SReal	getTime () const
	Current time. More...

Public Member Functions inherited from sofa::core::objectmodel::Base
virtual const BaseClass *	getClass () const

void	addDeprecatedAttribute (lifecycle::DeprecatedData *attribute)

void	addUpdateCallback (const std::string &name, std::initializer_list< BaseData * > inputs, std::function< sofa::core::objectmodel::ComponentState(const DataTracker &)> function, std::initializer_list< BaseData * > outputs)

void	addOutputsToCallback (const std::string &name, std::initializer_list< BaseData * > outputs)

const std::string &	getName () const
	Accessor to the object name. More...

void	setName (const std::string &n)
	Set the name of this object. More...

void	setName (const std::string &n, int counter)
	Set the name of this object, adding an integer counter. More...

std::string	getTypeName () const
	Get the type name of this object (i.e. class and template types) More...

virtual std::string	getClassName () const
	Get the class name of this object. More...

virtual std::string	getTemplateName () const final
	Get the template type names (if any) used to instantiate this object. More...

std::string	getNameSpaceName () const
	Get the template type names (if any) used to instantiate this object. More...

void	setDefinitionSourceFileName (const std::string &sourceFileName)
	Set the source filename (where the component is implemented) More...

const std::string &	getDefinitionSourceFileName () const
	Get the source filename (where the component is implemented) More...

void	setDefinitionSourceFilePos (const int)
	Set the source location (where the component is implemented) More...

int	getDefinitionSourceFilePos () const
	Get the source location (where the component is implemented) More...

void	setInstanciationSourceFileName (const std::string &sourceFileName)

const std::string &	getInstanciationSourceFileName () const

void	setInstanciationSourceFilePos (const int)

int	getInstanciationSourceFilePos () const

void	addMessage (const sofa::helper::logging::Message &m) const

size_t	countLoggedMessages (sofa::helper::logging::Message::TypeSet t=sofa::helper::logging::Message::AnyTypes) const

const std::deque< sofa::helper::logging::Message > &	getLoggedMessages () const

const std::string	getLoggedMessagesAsString (sofa::helper::logging::Message::TypeSet t=sofa::helper::logging::Message::AnyTypes) const

void	clearLoggedMessages () const

bool	notMuted () const

const sofa::core::objectmodel::TagSet &	getTags () const
	Represents the subsets the object belongs to. More...

bool	hasTag (Tag t) const
	Return true if the object belong to the given subset. More...

void	addTag (Tag t)
	Add a subset qualification to the object. More...

void	removeTag (Tag t)
	Remove a subset qualification to the object. More...

ComponentState	getComponentState () const

bool	isComponentStateValid () const

bool	isComponentStateInvalid () const

	SOFA_ATTRIBUTE_DEPRECATED__TOBASECONSTRAINT () virtual const behavior

	SOFA_ATTRIBUTE_DEPRECATED__TOBASEOBJECT () virtual const objectmodel

virtual bool	parseField (const std::string &attribute, const std::string &value)
	Assign one field value (Data or Link) More...

virtual bool	hasField (const std::string &attribute) const
	Check if a given Data field or Link exists. More...

void	parseFields (const std::list< std::string > &str)
	Assign the field values stored in the given list of name + value pairs of strings. More...

virtual void	parseFields (const std::map< std::string, std::string * > &str)
	Assign the field values stored in the given map of name -> value pairs. More...

void	writeDatas (std::ostream &out, const std::string &separator=" ")

BaseData *	findData (const std::string &name) const

std::vector< BaseData * >	findGlobalField (const std::string &name) const
	Find data fields given a name: several can be found as we look into the alias map. More...

BaseLink *	findLink (const std::string &name) const

std::vector< BaseLink * >	findLinks (const std::string &name) const
	Find link fields given a name: several can be found as we look into the alias map. More...

virtual void	updateLinks (bool logErrors=true)
	Update pointers in case the pointed-to objects have appeared. More...

template<class T >
BaseData::BaseInitData	initData (::sofa::core::objectmodel::Data< T > field, const char n, const char *help, ::sofa::core::objectmodel::BaseData::DataFlags dataflags)
	Helper method used to initialize a data field containing a value of type T. More...

template<class T >
BaseData::BaseInitData	initData (Data< T > field, const char n, const char *help, bool isDisplayed=true, bool isReadOnly=false)
	Helper method used to initialize a data field containing a value of type T. More...

template<class T >
Data< T >::InitData	initData (Data< T > field, const T &value, const char n, const char *help, bool isDisplayed=true, bool isReadOnly=false)
	Helper method used to initialize a data field containing a value of type T. More...

void	addData (BaseData *f, const std::string &name)

void	addData (BaseData *f)

void	removeData (BaseData *f)
	Remove a data field. More...

void	addAlias (BaseData field, const char alias)
	Add an alias to a Data. More...

void	addLink (BaseLink *l)
	Add a link. More...

void	addAlias (BaseLink link, const char alias)
	Add an alias to a Link. More...

const VecData &	getDataFields () const
	Accessor to the vector containing all the fields of this object. More...

const MapData &	getDataAliases () const
	Accessor to the map containing all the aliases of this object. More...

const VecLink &	getLinks () const
	Accessor to the vector containing all the fields of this object. More...

const MapLink &	getLinkAliases () const
	Accessor to the map containing all the aliases of this object. More...

virtual bool	findDataLinkDest (BaseData &ptr, const std::string &path, const BaseLink link)

template<class T >
bool	findLinkDest (T &ptr, const std::string &path, const BaseLink link)

Protected Member Functions
	BaseComponent ()

	~BaseComponent () override

virtual void	doUpdateInternal ()
	Implementation of the internal update. More...

void	changeContextLink (BaseContext before, BaseContext &after)

void	changeSlavesLink (BaseComponent::SPtr ptr, std::size_t, bool add)
	This method insures that slaves objects have master and context links set correctly. More...

Protected Member Functions inherited from sofa::core::objectmodel::Base
	Base ()

virtual	~Base ()

void	initData0 (BaseData field, BaseData::BaseInitData &res, const char name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
	Helper method used by initData() More...

void	initData0 (BaseData field, BaseData::BaseInitData &res, const char name, const char *help, BaseData::DataFlags dataFlags)
	Helper method used by initData() More...

template<class T >
void	initData0 (Data< T > field, typename Data< T >::InitData &res, const T &value, const char n, const char *help, bool isDisplayed=true, bool isReadOnly=false)
	Helper method used by initData() More...

Protected Member Functions inherited from sofa::core::IntrusiveObject
virtual	~IntrusiveObject ()=default

Friends
class	BaseNode
	BaseNode can set the context of its own objects. More...

Context accessors
typedef sofa::core::objectmodel::MultiLink< BaseComponent, BaseComponent, BaseLink::FLAG_DOUBLELINK\|BaseLink::FLAG_STRONGLINK >	LinkSlaves

typedef LinkSlaves::Container	VecSlaves

const BaseContext *	getContext () const

BaseContext *	getContext ()

const BaseComponent *	getMaster () const

BaseComponent *	getMaster ()

const VecSlaves &	getSlaves () const

BaseComponent *	getSlave (const std::string &name) const

virtual void	addSlave (BaseComponent::SPtr s)

virtual void	removeSlave (BaseComponent::SPtr s)

events
Methods related to Event processing
Data< bool >	f_listening
	if true, handle the events, otherwise ignore the events More...

virtual void	handleEvent (Event *)
	Handle an event. More...

virtual void	handleTopologyChange ()

virtual void	handleTopologyChange (core::topology::Topology *t)

internalupdate
Methods related to tracking of data and the internal update
void	trackInternalData (const BaseData &data)
	Method called to add the Data to the DataTracker (listing the Data to track) More...

void	cleanTracker ()

bool	hasDataChanged (const BaseData &data)
	Method called to know if a tracked Data has changed. More...

control
Basic control
void	parse (BaseObjectDescription *arg) override
	Parse the given description to assign values to this object's fields and potentially other parameters. More...

virtual void	init ()
	Initialization method called at graph creation and modification, during top-down traversal. More...

virtual void	bwdInit ()
	Initialization method called at graph creation and modification, during bottom-up traversal. More...

virtual void	reinit ()
	Update method called when variables used in precomputation are modified. More...

void	updateInternal ()
	Update method called when variables (used to compute other internal variables) are modified. More...

virtual void	storeResetState ()
	Save the initial state for later uses in reset() More...

virtual void	reset ()
	Reset to initial state. More...

virtual void	cleanup ()

template<class T >
static bool	canCreate (T , BaseContext , BaseObjectDescription *)
	Pre-construction check method called by ObjectFactory. More...

template<class T >
static T::SPtr	create (T , BaseContext context, BaseObjectDescription *arg)
	Construction method called by ObjectFactory. More...

Additional Inherited Members
Public Attributes inherited from sofa::core::objectmodel::Base
std::vector< lifecycle::DeprecatedData * >	m_oldAttributes

Data< int >	d_messageLogCount

Data< std::string >	name
	Name of the object. More...

Data< bool >	f_printLog
	if true, emits extra messages at runtime. More...

Data< sofa::core::objectmodel::TagSet >	f_tags
	list of the subsets the object belongs to More...

Data< sofa::type::BoundingBox >	f_bbox
	this object bounding box More...

Data< sofa::core::objectmodel::ComponentState >	d_componentState
	The state of the component among (Dirty, Valid, Undefined, Loading, Invalid). More...

std::string	m_definitionSourceFileName {""}

int	m_definitionSourceFilePos {-1}

std::string	m_instanciationSourceFileName {""}

int	m_instanciationSourceFilePos {-1}

Static Public Member Functions inherited from sofa::core::objectmodel::Base
static const BaseClass *	GetClass ()

template<class T >
static std::string	shortName (const T ptr=nullptr, BaseObjectDescription =nullptr)

Attribute details

◆ f_listening

Data<bool> sofa::core::objectmodel::BaseComponent::f_listening

if true, handle the events, otherwise ignore the events

◆ l_context

SingleLink<BaseComponent, BaseContext, BaseLink::FLAG_DOUBLELINK> sofa::core::objectmodel::BaseComponent::l_context

protected

◆ l_master

SingleLink<BaseComponent, BaseComponent, BaseLink::FLAG_DOUBLELINK> sofa::core::objectmodel::BaseComponent::l_master

protected

◆ l_slaves

LinkSlaves sofa::core::objectmodel::BaseComponent::l_slaves

protected

Constructor details

◆ BaseComponent()

sofa::core::objectmodel::BaseComponent::BaseComponent ( )

protected

◆ ~BaseComponent()

sofa::core::objectmodel::BaseComponent::~BaseComponent ( )

overrideprotected

Function details

◆ addSlave()

void sofa::core::objectmodel::BaseComponent::addSlave ( BaseComponent::SPtr s )

virtual

◆ bwdInit()

void sofa::core::objectmodel::BaseComponent::bwdInit ( )

virtual

Initialization method called at graph creation and modification, during bottom-up traversal.

◆ canCreate()

template<class T >

static bool sofa::core::objectmodel::BaseComponent::canCreate	(	T *	,
		BaseContext *	,
		BaseObjectDescription *
	)

inlinestatic

Pre-construction check method called by ObjectFactory.

◆ changeContextLink()

void sofa::core::objectmodel::BaseComponent::changeContextLink	(	BaseContext *	before,
		BaseContext *&	after
	)

protected

This method insures that context is never nullptr (using BaseContext::getDefault() instead) and that all slaves of an object share its context

◆ changeSlavesLink()

void sofa::core::objectmodel::BaseComponent::changeSlavesLink	(	BaseComponent::SPtr	ptr,
		std::size_t	,
		bool	add
	)

protected

This method insures that slaves objects have master and context links set correctly.

◆ cleanTracker()

void sofa::core::objectmodel::BaseComponent::cleanTracker ( )

protected

◆ cleanup()

void sofa::core::objectmodel::BaseComponent::cleanup ( )

virtual

Called just before deleting this object Any object in the tree below this object that are to be removed will be removed only after this call, so any references this object holds should still be valid.

◆ computeBBox()

virtual void sofa::core::objectmodel::BaseComponent::computeBBox	(	const core::ExecParams *	,
		bool	= `false`
	)

inlinevirtual

Bounding Box computation method. Default to empty method.

◆ create()

template<class T >

static T::SPtr sofa::core::objectmodel::BaseComponent::create	(	T *	,
		BaseContext *	context,
		BaseObjectDescription *	arg
	)

inlinestatic

Construction method called by ObjectFactory.

◆ doUpdateInternal()

void sofa::core::objectmodel::BaseComponent::doUpdateInternal ( )

protectedvirtual

Implementation of the internal update.

Reimplemented in sofa::component::mass::MeshMatrixMass< DataTypes, GeometricalTypes >, sofa::component::mass::DiagonalMass< DataTypes, GeometricalTypes >, and sofa::component::mass::DiagonalMass< DataTypes, GeometricalTypes >.

◆ draw()

virtual void sofa::core::objectmodel::BaseComponent::draw ( const core::visual::VisualParams * )

inlinevirtual

Render internal data of this object, for debugging purposes.

◆ findLinkDestClass()

Base * sofa::core::objectmodel::BaseComponent::findLinkDestClass	(	const BaseClass *	destType,
		const std::string &	path,
		const BaseLink *	link
	)

overridevirtual

Reimplemented from sofa::core::objectmodel::Base.

◆ getContext() [1/2]

BaseContext * sofa::core::objectmodel::BaseComponent::getContext ( )

◆ getContext() [2/2]

const BaseContext * sofa::core::objectmodel::BaseComponent::getContext ( ) const

◆ getMaster() [1/2]

BaseComponent * sofa::core::objectmodel::BaseComponent::getMaster ( )

◆ getMaster() [2/2]

const BaseComponent * sofa::core::objectmodel::BaseComponent::getMaster ( ) const

◆ getPathName()

std::string sofa::core::objectmodel::BaseComponent::getPathName ( ) const

overridevirtual

Return the full path name of this object.

Reimplemented from sofa::core::objectmodel::Base.

◆ getSlave()

BaseComponent * sofa::core::objectmodel::BaseComponent::getSlave ( const std::string & name ) const

◆ getSlaves()

const BaseComponent::VecSlaves & sofa::core::objectmodel::BaseComponent::getSlaves ( ) const

◆ getTime()

SReal sofa::core::objectmodel::BaseComponent::getTime ( ) const

Current time.

◆ handleEvent()

void sofa::core::objectmodel::BaseComponent::handleEvent ( Event * )

virtual

Handle an event.

◆ handleTopologyChange() [1/2]

virtual void sofa::core::objectmodel::BaseComponent::handleTopologyChange ( )

inlinevirtual

Handle topological Changes

Reimplemented in sofa::gl::component::shader::OglShaderVisualModel, sofa::component::solidmechanics::fem::elastic::TetrahedronFEMForceField< DataTypes >, sofa::component::solidmechanics::fem::elastic::HexahedronFEMForceField< DataTypes >, sofa::component::constraint::projective::PositionBasedDynamicsProjectiveConstraint< DataTypes >, and sofa::component::collision::geometry::LineCollisionModel< TDataTypes >.

◆ handleTopologyChange() [2/2]

void sofa::core::objectmodel::BaseComponent::handleTopologyChange ( core::topology::Topology * t )

virtual

Handle topological Changes from a given Topology

Reimplemented in sofa::component::solidmechanics::fem::nonuniform::NonUniformHexahedralFEMForceFieldAndMass< DataTypes >.

◆ hasDataChanged()

bool sofa::core::objectmodel::BaseComponent::hasDataChanged ( const BaseData & data )

protected

Method called to know if a tracked Data has changed.

◆ init()

void sofa::core::objectmodel::BaseComponent::init ( void )

virtual

Initialization method called at graph creation and modification, during top-down traversal.

◆ insertInNode()

virtual bool sofa::core::objectmodel::BaseComponent::insertInNode ( BaseNode * )

inlinevirtual

the component can insert itself directly in the right sequence in the Node so the Node does not have to test its type against all known types

Returns: true if the component was inserted

◆ parse()

void sofa::core::objectmodel::BaseComponent::parse ( BaseObjectDescription * arg )

overridevirtual

Parse the given description to assign values to this object's fields and potentially other parameters.

Reimplemented from sofa::core::objectmodel::Base.

Reimplemented in sofa::gl::component::rendering3d::MergeVisualModels, sofa::simulation::RequiredPlugin, sofa::component::mass::DiagonalMass< DataTypes, GeometricalTypes >, sofa::gl::component::shader::OglShader, sofa::gl::component::rendering3d::OglModel, sofa::gl::component::rendering2d::OglLabel, and sofa::component::statecontainer::MechanicalObject< T >.

◆ reinit()

void sofa::core::objectmodel::BaseComponent::reinit ( )

virtual

Update method called when variables used in precomputation are modified.

◆ removeInNode()

virtual bool sofa::core::objectmodel::BaseComponent::removeInNode ( BaseNode * )

inlinevirtual

the component can remove itself directly in the right sequence in the Node so the Node does not have to test its type against all known types

Returns: true if the component was removed

◆ removeSlave()

void sofa::core::objectmodel::BaseComponent::removeSlave ( BaseComponent::SPtr s )

virtual

◆ reset()

void sofa::core::objectmodel::BaseComponent::reset ( )

virtual

Reset to initial state.

◆ setSrc() [1/2]

void sofa::core::objectmodel::BaseComponent::setSrc	(	const std::string &	v,
		const BaseComponent *	loader,
		std::vector< std::string > *	attributeList = `nullptr`
	)

Sets a source Object and parses it to collect dependent Data Use it before scene graph insertion

◆ setSrc() [2/2]

void sofa::core::objectmodel::BaseComponent::setSrc	(	const std::string &	v,
		std::vector< std::string > *	attributeList = `nullptr`
	)

Sets a source Object and parses it to collect dependent Data.

◆ SOFA_CLASS()

sofa::core::objectmodel::BaseComponent::SOFA_CLASS	(	BaseComponent	,
		Base
	)

◆ storeResetState()

void sofa::core::objectmodel::BaseComponent::storeResetState ( )

virtual

Save the initial state for later uses in reset()

Reimplemented in sofa::core::behavior::BaseAnimationLoop, sofa::component::statecontainer::MechanicalObject< DataTypes >, sofa::component::statecontainer::MechanicalObject< T >, and sofa::component::mechanicalload::TaitSurfacePressureForceField< DataTypes >.

◆ trackInternalData()

void sofa::core::objectmodel::BaseComponent::trackInternalData ( const BaseData & data )

protected

Method called to add the Data to the DataTracker (listing the Data to track)

◆ updateInternal()

void sofa::core::objectmodel::BaseComponent::updateInternal ( )

Update method called when variables (used to compute other internal variables) are modified.

Related details

◆ BaseNode

friend class BaseNode

friend

BaseNode can set the context of its own objects.

Detailed Description

Protected Attributes

Public Member Functions

Protected Member Functions

Friends

Context accessors

events

internalupdate

control

Additional Inherited Members

Attribute details

◆ f_listening

◆ l_context

◆ l_master

◆ l_slaves

Constructor details

◆ BaseComponent()

◆ ~BaseComponent()

Function details

◆ addSlave()

◆ bwdInit()

◆ canCreate()

◆ changeContextLink()

◆ changeSlavesLink()

◆ cleanTracker()

◆ cleanup()

◆ computeBBox()

◆ create()

◆ doUpdateInternal()

◆ draw()

◆ findLinkDestClass()

◆ getContext() [1/2]

◆ getContext() [2/2]

◆ getMaster() [1/2]

◆ getMaster() [2/2]

◆ getPathName()

◆ getSlave()

◆ getSlaves()

◆ getTime()

◆ handleEvent()

◆ handleTopologyChange() [1/2]

◆ handleTopologyChange() [2/2]

◆ hasDataChanged()

◆ init()

◆ insertInNode()

◆ parse()

◆ reinit()

◆ removeInNode()

◆ removeSlave()

◆ reset()

◆ setSrc() [1/2]

◆ setSrc() [2/2]

◆ SOFA_CLASS()

◆ storeResetState()

◆ trackInternalData()

◆ updateInternal()

Related details

◆ BaseNode