#include <DataEngine.h>
from a set of Data inputs computes a set of Data outputs More...

from a set of Data inputs computes a set of Data outputs
Implementation good rules:
void init() { addInput // indicate all inputs addOutput // indicate all outputs }
// optional (called each time a data is modified in the gui) // it is not always desired void reinit() { update(); }
void doUpdate() override { access your inputs, set your outputs... }
| Public Member Functions | |
| SOFA_ABSTRACT_CLASS (DataEngine, core::objectmodel::BaseObject) | |
| void | update () final | 
| void | addInput (sofa::core::objectmodel::BaseData *data) | 
| Add a new input to this engine.  More... | |
| void | addOutput (objectmodel::BaseData *n) | 
| Add a new output to this engine.  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 DDGLinkContainer & | getInputs () | 
| Get the list of inputs for this DDGNode.  More... | |
| const DDGLinkContainer & | getOutputs () | 
| Get the list of outputs for this DDGNode.  More... | |
| bool | isDirty () const | 
| Returns true if the DDGNode needs to be updated.  More... | |
| virtual void | setDirtyValue () | 
| Indicate the value needs to be updated.  More... | |
| virtual void | setDirtyOutputs () | 
| Indicate the outputs needs to be updated. This method must be called after changing the value of this node.  More... | |
| void | cleanDirty () | 
| Set dirty flag to false.  More... | |
| virtual void | notifyEndEdit () | 
| Notify links that the DGNode has been modified.  More... | |
| void | updateIfDirty () const | 
| Utility method to call update if necessary. This method should be called before reading of writing the value of this node.  More... | |
|  Public Member Functions inherited from sofa::core::objectmodel::BaseObject | |
| SOFA_CLASS (BaseObject, 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 BaseObject *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 *) | 
| SReal | getTime () const | 
| Current time.  More... | |
| const BaseContext * | getContext () const | 
| BaseContext * | getContext () | 
| const BaseObject * | getMaster () const | 
| BaseObject * | getMaster () | 
| const VecSlaves & | getSlaves () const | 
| BaseObject * | getSlave (const std::string &name) const | 
| virtual void | addSlave (BaseObject::SPtr s) | 
| virtual void | removeSlave (BaseObject::SPtr s) | 
| virtual void | handleEvent (Event *) | 
| Handle an event.  More... | |
| virtual void | handleTopologyChange () | 
| virtual void | handleTopologyChange (core::topology::Topology *t) | 
| 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 () | 
|  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 | |
| 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::map< std::string, std::string * > &str)=delete | 
| Write the current field values to 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 *name, 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 *name, 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 *name, 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 | |
| DataEngine () | |
| Constructor.  More... | |
| ~DataEngine () override | |
| Destructor. Do nothing.  More... | |
| virtual void | doUpdate ()=0 | 
| Where you put your engine's impl.  More... | |
| virtual void | doInternalUpdate () final | 
| Prevent engines to use the internalUpdate mechanism, so that only update/doUpdate is used.  More... | |
|  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 () | 
| the dirtyOutputs flags of all the inputs will be set to false  More... | |
|  Protected Member Functions inherited from sofa::core::objectmodel::BaseObject | |
| BaseObject () | |
| ~BaseObject () override | |
| virtual void | doUpdateInternal () | 
| Implementation of the internal update.  More... | |
| void | changeContextLink (BaseContext *before, BaseContext *&after) | 
| void | changeSlavesLink (BaseObject::SPtr ptr, std::size_t, bool add) | 
| This method insures that slaves objects have master and context links set correctly.  More... | |
| 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... | |
|  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 *name, 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 | 
| Additional Inherited Members | |
|  Public Attributes inherited from sofa::core::objectmodel::BaseObject | |
| Data< bool > | f_listening | 
| if true, handle the events, otherwise ignore the events  More... | |
|  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} | 
|  Protected Attributes inherited from sofa::core::DataTrackerDDGNode | |
| DataTracker | m_dataTracker | 
|  Protected Attributes inherited from sofa::core::objectmodel::DDGNode | |
| DDGLinkContainer | inputs | 
| DDGLinkContainer | outputs | 
|  Protected Attributes inherited from sofa::core::objectmodel::BaseObject | |
| SingleLink< BaseObject, BaseContext, BaseLink::FLAG_DOUBLELINK > | l_context | 
| LinkSlaves | l_slaves | 
| SingleLink< BaseObject, BaseObject, 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... | |
|  Static Public Member Functions inherited from sofa::core::objectmodel::BaseObject | |
| 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... | |
|  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) | 
| 
 | protected | 
Constructor.
| 
 | overrideprotected | 
Destructor. Do nothing.
| void sofa::core::DataEngine::addInput | ( | sofa::core::objectmodel::BaseData * | data | ) | 
Add a new input to this engine.
Add a new input to this engine Automatically adds the input fields to the datatracker
| void sofa::core::DataEngine::addOutput | ( | objectmodel::BaseData * | n | ) | 
Add a new output to this engine.
| 
 | inlinefinalprotectedvirtual | 
Prevent engines to use the internalUpdate mechanism, so that only update/doUpdate is used.
| 
 | protectedpure virtual | 
Where you put your engine's impl.
Implemented in sofa::component::engine::transform::AbstractTransformMatrixEngine, sofa::gl::component::engine::TextureInterpolation< DataTypes >, sofa::component::engine::transform::Vertex2Frame< DataTypes >, sofa::component::engine::transform::TransformPosition< DataTypes >, sofa::component::engine::transform::ScaleTransformMatrixEngine, sofa::component::engine::transform::RotateTransformMatrixEngine, sofa::component::engine::transform::TranslateTransformMatrixEngine, sofa::component::engine::transform::InvertTransformMatrixEngine, sofa::component::engine::transform::TransformEngine< DataTypes >, sofa::component::engine::transform::SmoothMeshEngine< DataTypes >, sofa::component::engine::transform::ROIValueMapper, sofa::component::engine::transform::RigidToQuatEngine< DataTypes >, sofa::component::engine::transform::QuatToRigidEngine< DataTypes >, sofa::component::engine::transform::ProjectiveTransformEngine< DataTypes >, sofa::component::engine::transform::MathOp< VecT >, sofa::component::engine::transform::MapIndices< T >, sofa::component::engine::transform::Indices2ValuesMapper< DataTypes >, sofa::component::engine::transform::IndexValueMapper< DataTypes >, sofa::component::engine::transform::DisplacementMatrixEngine< DataTypes >, sofa::component::engine::transform::DisplacementTransformEngine< DataTypes, OutputType >, sofa::component::engine::transform::DisplacementTransformEngine< DataTypes, type::Mat4x4 >, sofa::component::engine::transform::DilateEngine< DataTypes >, sofa::component::engine::transform::DifferenceEngine< TDataType >, sofa::component::engine::select::ValuesFromPositions< DataTypes >, sofa::component::engine::select::ValuesFromIndices< T >, sofa::component::engine::select::SubsetTopology< DataTypes >, sofa::component::engine::select::SelectLabelROI< _T >, sofa::component::engine::select::SelectConnectedLabelsROI< _T >, sofa::component::engine::select::ProximityROI< DataTypes >, sofa::component::engine::select::PointsFromIndices< DataTypes >, sofa::component::engine::select::PlaneROI< DataTypes >, sofa::component::engine::select::PairBoxROI< DataTypes >, sofa::component::engine::select::NearestPointROI< DataTypes >, sofa::component::engine::select::MeshSubsetEngine< DataTypes >, sofa::component::engine::select::MeshSplittingEngine< DataTypes >, sofa::component::engine::select::MeshSampler< DataTypes >, sofa::component::engine::select::MeshBoundaryROI, sofa::component::engine::select::MergeROIs, sofa::component::engine::select::IndicesFromValues< T >, sofa::component::engine::select::ComplementaryROI< DataTypes >, sofa::component::engine::select::BaseROI< DataTypes >, sofa::component::engine::generate::Spiral< DataTypes >, sofa::component::engine::generate::RandomPointDistributionInSurface< DataTypes >, sofa::component::engine::generate::NormEngine< TDataType >, sofa::component::engine::generate::NormalsFromPoints< DataTypes >, sofa::component::engine::generate::MeshTetraStuffing, sofa::component::engine::generate::MeshClosingEngine< DataTypes >, sofa::component::engine::generate::MeshBarycentricMapperEngine< DataTypes >, sofa::component::engine::generate::MergeVectors< VecT >, sofa::component::engine::generate::MergeSets< T >, sofa::component::engine::generate::MergePoints< DataTypes >, sofa::component::engine::generate::MergeMeshes< DataTypes >, sofa::component::engine::generate::JoinPoints< DataTypes >, sofa::component::engine::generate::GroupFilterYoungModulus< DataTypes >, sofa::component::engine::generate::GenerateSphere< DataTypes >, sofa::component::engine::generate::GenerateRigidMass< DataTypes, MassType >, sofa::component::engine::generate::GenerateGrid< DataTypes >, sofa::component::engine::generate::GenerateCylinder< DataTypes >, sofa::component::engine::generate::ExtrudeSurface< DataTypes >, sofa::component::engine::generate::ExtrudeQuadsAndGenerateHexas< DataTypes >, sofa::component::engine::generate::ExtrudeEdgesAndGenerateQuads< DataTypes >, sofa::component::engine::analyze::SumEngine< TDataType >, sofa::component::engine::analyze::ShapeMatching< DataTypes >, sofa::component::engine::analyze::HausdorffDistance< DataTypes >, sofa::component::engine::analyze::Distances< DataTypes >, sofa::component::engine::analyze::ClusteringEngine< DataTypes >, sofa::component::engine::analyze::AverageCoord< DataTypes >, sofa::component::engine::analyze::ShapeMatching< DataTypes >, and sofa::component::engine::analyze::ShapeMatching< DataTypes >.
| sofa::core::DataEngine::SOFA_ABSTRACT_CLASS | ( | DataEngine | , | 
| core::objectmodel::BaseObject | |||
| ) | 
| 
 | finalvirtual | 
Updates your inputs and calls cleanDirty() for you. User implementation moved to doUpdate()
Implements sofa::core::objectmodel::DDGNode.