sofa::simulation::tree::GNodeVisitor Class Reference
Base class for the Visitors which deal with GNodes specifically rather than Node. More...
#include <GNodeVisitor.h>
Public Member Functions | |
| GNodeVisitor () | |
| ~GNodeVisitor () | |
| virtual Result | processNodeTopDown (GNode *) |
| Callback method called when decending to a new node. Recursion will stop if this method returns RESULT_PRUNE. | |
| virtual void | processNodeBottomUp (GNode *) |
| Callback method called after child node have been processed and before going back to the parent node. | |
| virtual Result | processNodeTopDown (GNode *node, LocalStorage *) |
| Callback method called when decending to a new node. | |
| virtual void | processNodeBottomUp (GNode *node, LocalStorage *) |
| Callback method called after child node have been processed and before going back to the parent node. | |
| virtual Result | processNodeTopDown (simulation::Node *node) |
| Callback method called when decending to a new node. Recursion will stop if this method returns RESULT_PRUNE. | |
| virtual void | processNodeBottomUp (simulation::Node *node) |
| Callback method called after child node have been processed and before going back to the parent node. | |
| template<class Act , class Container , class Object > | |
| void | for_each (Act *action, GNode *node, const Container &list, void(Act::*fn)(GNode *, Object *)) |
| Helper method to enumerate objects in the given list. The callback gets the pointer to node. | |
| template<class Act , class Container , class Object > | |
| Visitor::Result | for_each_r (Act *action, GNode *node, const Container &list, Visitor::Result(Act::*fn)(GNode *, Object *)) |
| Helper method to enumerate objects in the given list. The callback gets the pointer to node. | |
Detailed Description
Base class for the Visitors which deal with GNodes specifically rather than Node.
Definition at line 53 of file GNodeVisitor.h.
Constructor & Destructor Documentation
| sofa::simulation::tree::GNodeVisitor::GNodeVisitor | ( | ) |
Definition at line 45 of file GNodeVisitor.cpp.
| sofa::simulation::tree::GNodeVisitor::~GNodeVisitor | ( | ) |
Definition at line 51 of file GNodeVisitor.cpp.
Member Function Documentation
| void sofa::simulation::tree::GNodeVisitor::for_each | ( | Act * | action, | |
| GNode * | node, | |||
| const Container & | list, | |||
| void(Act::*)(GNode *, Object *) | fn | |||
| ) | [inline] |
Helper method to enumerate objects in the given list. The callback gets the pointer to node.
Definition at line 105 of file GNodeVisitor.h.
References sofa::simulation::tree::GNode::endTime(), sofa::simulation::Visitor::getCategoryName(), sofa::simulation::Node::getLogTime(), and sofa::simulation::Node::startTime().
| Visitor::Result sofa::simulation::tree::GNodeVisitor::for_each_r | ( | Act * | action, | |
| GNode * | node, | |||
| const Container & | list, | |||
| Visitor::Result(Act::*)(GNode *, Object *) | fn | |||
| ) | [inline] |
Helper method to enumerate objects in the given list. The callback gets the pointer to node.
Definition at line 128 of file GNodeVisitor.h.
References sofa::simulation::tree::GNode::endTime(), sofa::simulation::Visitor::getCategoryName(), sofa::simulation::Node::getLogTime(), sofa::simulation::Visitor::RESULT_CONTINUE, and sofa::simulation::Node::startTime().
| virtual void sofa::simulation::tree::GNodeVisitor::processNodeBottomUp | ( | simulation::Node * | node | ) | [inline, virtual] |
Callback method called after child node have been processed and before going back to the parent node.
Reimplemented from sofa::simulation::Visitor.
Definition at line 90 of file GNodeVisitor.h.
References processNodeBottomUp().
| virtual void sofa::simulation::tree::GNodeVisitor::processNodeBottomUp | ( | GNode * | node, | |
| LocalStorage * | ||||
| ) | [inline, virtual] |
Callback method called after child node have been processed and before going back to the parent node.
This version is offered a LocalStorage to store temporary data
Definition at line 72 of file GNodeVisitor.h.
References processNodeBottomUp().
Referenced by processNodeBottomUp().
| virtual void sofa::simulation::tree::GNodeVisitor::processNodeBottomUp | ( | GNode * | ) | [inline, virtual] |
Callback method called after child node have been processed and before going back to the parent node.
Reimplemented in sofa::simulation::tree::CleanupVisitor, sofa::simulation::tree::DeleteVisitor, and sofa::simulation::tree::ExportDotVisitor.
Definition at line 64 of file GNodeVisitor.h.
Referenced by processNodeBottomUp().
| virtual Result sofa::simulation::tree::GNodeVisitor::processNodeTopDown | ( | simulation::Node * | node | ) | [inline, virtual] |
Callback method called when decending to a new node. Recursion will stop if this method returns RESULT_PRUNE.
Reimplemented from sofa::simulation::Visitor.
Definition at line 75 of file GNodeVisitor.h.
References processNodeTopDown(), and sofa::simulation::Visitor::RESULT_PRUNE.
| virtual Result sofa::simulation::tree::GNodeVisitor::processNodeTopDown | ( | GNode * | node, | |
| LocalStorage * | ||||
| ) | [inline, virtual] |
Callback method called when decending to a new node.
Recursion will stop if this method returns RESULT_PRUNE This version is offered a LocalStorage to store temporary data
Definition at line 68 of file GNodeVisitor.h.
References processNodeTopDown().
Referenced by processNodeTopDown().
| virtual Result sofa::simulation::tree::GNodeVisitor::processNodeTopDown | ( | GNode * | ) | [inline, virtual] |
Callback method called when decending to a new node. Recursion will stop if this method returns RESULT_PRUNE.
Reimplemented in sofa::simulation::tree::CleanupVisitor, sofa::simulation::tree::DeleteVisitor, and sofa::simulation::tree::ExportDotVisitor.
Definition at line 61 of file GNodeVisitor.h.
References sofa::simulation::Visitor::RESULT_CONTINUE.
Referenced by processNodeTopDown().
The documentation for this class was generated from the following files:
- modules/sofa/simulation/tree/GNodeVisitor.h
- modules/sofa/simulation/tree/GNodeVisitor.cpp
