SOFA API  82c4ea2a
Open source framework for multi-physics simuation
sofa::simulation::TopologyChangeVisitor Class Reference

#include <TopologyChangeVisitor.h>

Inheritance diagram for sofa::simulation::TopologyChangeVisitor:

Protected Attributes

sofa::core::topology::Topologym_source
 
- Protected Attributes inherited from sofa::simulation::Visitor
const sofa::core::ExecParamsparams
 

Public Member Functions

 TopologyChangeVisitor (const sofa::core::ExecParams *params, sofa::core::topology::Topology *source)
 
 ~TopologyChangeVisitor () override
 
virtual void processTopologyChange (simulation::Node *node, sofa::core::objectmodel::BaseObject *obj)
 
Result processNodeTopDown (simulation::Node *node) override
 Callback method called when descending to a new node. Recursion will stop if this method returns RESULT_PRUNE. More...
 
void processNodeBottomUp (simulation::Node *node) override
 Callback method called after child node have been processed and before going back to the parent node. More...
 
bool isThreadSafe () const override
 Specify whether this action can be parallelized. More...
 
const chargetCategoryName () const override
 
const chargetClassName () const override
 
std::string getInfos () const override
 
- Public Member Functions inherited from sofa::simulation::Visitor
 Visitor (const sofa::core::ExecParams *params)
 
virtual ~Visitor ()
 
const sofa::core::ExecParamsexecParams () const
 
virtual bool childOrderReversed (simulation::Node *)
 Return true to reverse the order of traversal of child nodes. More...
 
virtual bool treeTraversal (TreeTraversalRepetition &repeat)
 
bool testTags (sofa::core::objectmodel::BaseObject *obj)
 
virtual void execute (sofa::core::objectmodel::BaseContext *node, bool precomputedOrder=false)
 Alias for context->executeVisitor(this) More...
 
virtual ctime_t begin (simulation::Node *node, sofa::core::objectmodel::BaseObject *obj, const std::string &typeInfo=std::string("type"))
 
virtual void end (simulation::Node *node, sofa::core::objectmodel::BaseObject *obj, ctime_t t0)
 
virtual ctime_t begin (simulation::Visitor::VisitorContext *node, sofa::core::objectmodel::BaseObject *obj, const std::string &typeInfo=std::string("type"))
 
virtual void end (simulation::Visitor::VisitorContext *node, sofa::core::objectmodel::BaseObject *obj, ctime_t t0)
 
virtual Result processNodeTopDown (simulation::Node *node, LocalStorage *)=delete
 
virtual void processNodeBottomUp (simulation::Node *node, LocalStorage *)=delete
 
VisitorsetTags (const TagSet &t)
 
VisitoraddTag (Tag t)
 
VisitorremoveTag (Tag t)
 
template<class VisitorType , class VContext , class Container , typename PointedType >
void for_each (VisitorType *visitor, VContext *ctx, const Container &list, void(VisitorType::*task)(VContext *, PointedType *), const std::string &typeInfo)
 
template<class VisitorType , class VContext , class Container , typename PointedType >
Visitor::Result for_each (VisitorType *visitor, VContext *ctx, const Container &list, Visitor::Result(VisitorType::*task)(VContext *, PointedType *), const std::string &typeInfo)
 

Additional Inherited Members

- Public Attributes inherited from sofa::simulation::Visitor
TagSet subsetsToManage
 list of the subsets More...
 
bool canAccessSleepingNode
 Can the visitor access sleeping nodes? More...
 
- Protected Member Functions inherited from sofa::simulation::Visitor
void debug_write_state_before (sofa::core::objectmodel::BaseObject *obj)
 
void debug_write_state_after (sofa::core::objectmodel::BaseObject *obj)
 
template<class VisitorType , class VContext , class ObjectType >
void runVisitorTask (VisitorType *visitor, VContext *ctx, void(VisitorType::*task)(VContext *, ObjectType *), ObjectType *ptr, const std::string &typeInfo=std::string("type"))
 
template<class VisitorType , class VContext , class ObjectType >
Result runVisitorTask (VisitorType *visitor, VContext *ctx, Result(VisitorType::*task)(VContext *, ObjectType *), ObjectType *ptr, const std::string &typeInfo=std::string("type"))
 
template<class Visit , class VContext , class Container , typename PointedType = typename Container::pointed_type>
void for_each (Visit *visitor, VContext *ctx, const Container &list, void(Visit::*task)(VContext *, PointedType *), const std::string &typeInfo=std::string("type"))
 
template<class Visit , class VContext , class Container , typename PointedType = typename Container::pointed_type>
Visitor::Result for_each (Visit *visitor, VContext *ctx, const Container &list, Visitor::Result(Visit::*task)(VContext *, PointedType *), const std::string &typeInfo=std::string("type"))
 

Attribute details

◆ m_source

sofa::core::topology::Topology* sofa::simulation::TopologyChangeVisitor::m_source
protected

Constructor details

◆ TopologyChangeVisitor()

sofa::simulation::TopologyChangeVisitor::TopologyChangeVisitor ( const sofa::core::ExecParams params,
sofa::core::topology::Topology source 
)

◆ ~TopologyChangeVisitor()

sofa::simulation::TopologyChangeVisitor::~TopologyChangeVisitor ( )
inlineoverride

Function details

◆ getCategoryName()

const char* sofa::simulation::TopologyChangeVisitor::getCategoryName ( ) const
inlineoverridevirtual

Return a category name for this action. Only used for debugging / profiling purposes

Reimplemented from sofa::simulation::Visitor.

◆ getClassName()

const char* sofa::simulation::TopologyChangeVisitor::getClassName ( ) const
inlineoverridevirtual

Return a class name for this visitor Only used for debugging / profiling purposes

Reimplemented from sofa::simulation::Visitor.

◆ getInfos()

std::string sofa::simulation::TopologyChangeVisitor::getInfos ( ) const
overridevirtual

Return eventual information on the behavior of the visitor Only used for debugging / profiling purposes

Reimplemented from sofa::simulation::Visitor.

◆ isThreadSafe()

bool sofa::simulation::TopologyChangeVisitor::isThreadSafe ( ) const
inlineoverridevirtual

Specify whether this action can be parallelized.

Reimplemented from sofa::simulation::Visitor.

◆ processNodeBottomUp()

void sofa::simulation::TopologyChangeVisitor::processNodeBottomUp ( simulation::Node )
overridevirtual

Callback method called after child node have been processed and before going back to the parent node.

Reimplemented from sofa::simulation::Visitor.

◆ processNodeTopDown()

Visitor::Result sofa::simulation::TopologyChangeVisitor::processNodeTopDown ( simulation::Node )
overridevirtual

Callback method called when descending to a new node. Recursion will stop if this method returns RESULT_PRUNE.

Reimplemented from sofa::simulation::Visitor.

◆ processTopologyChange()

void sofa::simulation::TopologyChangeVisitor::processTopologyChange ( simulation::Node node,
sofa::core::objectmodel::BaseObject obj 
)
virtual