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

#include <DataTracker.h>

Inheritance diagram for sofa::core::DataTrackerEngine:

Protected Attributes

std::vector< std::function< sofa::core::objectmodel::ComponentState(void)> > m_callbacks
std::string m_name {""}
sofa::core::objectmodel::Basem_owner {nullptr}
- Protected Attributes inherited from sofa::core::DataTrackerDDGNode
DataTracker m_dataTracker
- Protected Attributes inherited from sofa::core::objectmodel::DDGNode
DDGLinkContainer inputs
DDGLinkContainer outputs

Public Member Functions

 DataTrackerEngine ()
void addCallback (std::function< sofa::core::objectmodel::ComponentState(void)> f)
void update () override
 Calls the callback when one of the data has changed. More...
- Public Member Functions inherited from sofa::core::DataTrackerDDGNode
 DataTrackerDDGNode ()
void addInputs (std::initializer_list< sofa::core::objectmodel::BaseData * > datas)
 Create a DataCallback object associated with multiple Data fields. More...
void addOutputs (std::initializer_list< sofa::core::objectmodel::BaseData * > datas)
virtual void cleanDirty (const core::ExecParams *params=nullptr)
void updateAllInputsIfDirty ()
- Public Member Functions inherited from sofa::core::objectmodel::DDGNode
 DDGNode ()
 Constructor. More...
virtual ~DDGNode ()
 Destructor. Automatically remove remaining links. More...
void addInput (DDGNode *n)
 Add a new input to this node. More...
void delInput (DDGNode *n)
 Remove an input from this node. More...
void addOutput (DDGNode *n)
 Add a new output to this node. More...
void delOutput (DDGNode *n)
 Remove an output from this node. More...
const DDGLinkContainergetInputs ()
 Get the list of inputs for this DDGNode. More...
const DDGLinkContainergetOutputs ()
 Get the list of outputs for this DDGNode. More...
bool isDirty (const core::ExecParams *) const
 Returns true if the DDGNode needs to be updated. More...
bool isDirty () const
virtual void setDirtyValue (const core::ExecParams *) final
 Indicate the value needs to be updated. More...
virtual void setDirtyValue ()
virtual void setDirtyOutputs (const core::ExecParams *) final
 Indicate the outputs needs to be updated. This method must be called after changing the value of this node. More...
virtual void setDirtyOutputs ()
void cleanDirty (const core::ExecParams *)
 Set dirty flag to false. More...
void cleanDirty ()
virtual void notifyEndEdit (const core::ExecParams *) final
 Notify links that the DGNode has been modified. More...
virtual void notifyEndEdit ()
void updateIfDirty (const core::ExecParams *) const
 Utility method to call update if necessary. This method should be called before reading of writing the value of this node. More...
void updateIfDirty () const

Additional Inherited Members

- Protected Member Functions inherited from sofa::core::objectmodel::DDGNode
virtual void doAddInput (DDGNode *n)
virtual void doDelInput (DDGNode *n)
virtual void doAddOutput (DDGNode *n)
virtual void doDelOutput (DDGNode *n)
void cleanDirtyOutputsOfInputs (const core::ExecParams *)
 the dirtyOutputs flags of all the inputs will be set to false More...
void cleanDirtyOutputsOfInputs ()

Attribute details

std::vector<std::function<sofa::core::objectmodel::ComponentState(void)> > sofa::core::DataTrackerEngine::m_callbacks
std::string sofa::core::DataTrackerEngine::m_name {""}
sofa::core::objectmodel::Base* sofa::core::DataTrackerEngine::m_owner {nullptr}

Constructor details

sofa::core::DataTrackerEngine::DataTrackerEngine ( )

Function details

void sofa::core::DataTrackerEngine::addCallback ( std::function< sofa::core::objectmodel::ComponentState(void)>  f)

set the update function to call when asking for an output and any input changed.

void sofa::core::DataTrackerEngine::update ( )

Calls the callback when one of the data has changed.

Each callback in the engine is called, setting its owner's component state to the value returned by the last callback. Because each callback overwrites the state of the same component, it is important that within a component, all callbacks perform the same checks to determine the value of the ComponentState.

Implements sofa::core::objectmodel::DDGNode.