sofa::simulation::InstrumentVisitor Class Reference
#include <InstrumentVisitor.h>
Public Member Functions | |
| InstrumentVisitor () | |
| 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 bool | isThreadSafe () const |
| Specify whether this action can be parallelized. | |
| virtual const char * | getCategoryName () const |
| Return a category name for this action. | |
| sofa::helper::vector < simulation::Node * > & | getInstruments () |
Protected Attributes | |
| sofa::helper::vector < simulation::Node * > | instrumentNodes |
Detailed Description
Definition at line 40 of file InstrumentVisitor.h.
Constructor & Destructor Documentation
| sofa::simulation::InstrumentVisitor::InstrumentVisitor | ( | ) | [inline] |
Definition at line 44 of file InstrumentVisitor.h.
Member Function Documentation
| virtual const char* sofa::simulation::InstrumentVisitor::getCategoryName | ( | ) | const [inline, virtual] |
Return a category name for this action.
Only used for debugging / profiling purposes
Reimplemented from sofa::simulation::Visitor.
Definition at line 53 of file InstrumentVisitor.h.
| sofa::helper::vector< simulation::Node * >& sofa::simulation::InstrumentVisitor::getInstruments | ( | ) | [inline] |
Definition at line 55 of file InstrumentVisitor.h.
References instrumentNodes.
Referenced by sofa::simulation::tree::Simulation::getInstruments().
| virtual bool sofa::simulation::InstrumentVisitor::isThreadSafe | ( | ) | const [inline, virtual] |
Specify whether this action can be parallelized.
Reimplemented from sofa::simulation::Visitor.
Definition at line 49 of file InstrumentVisitor.h.
| Visitor::Result sofa::simulation::InstrumentVisitor::processNodeTopDown | ( | simulation::Node * | ) | [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 34 of file InstrumentVisitor.cpp.
References sofa::core::objectmodel::Base::getName(), instrumentNodes, and sofa::simulation::Visitor::RESULT_CONTINUE.
Field Documentation
sofa::helper::vector< simulation::Node * > sofa::simulation::InstrumentVisitor::instrumentNodes [protected] |
Definition at line 57 of file InstrumentVisitor.h.
Referenced by getInstruments(), and processNodeTopDown().
The documentation for this class was generated from the following files:
- modules/sofa/simulation/common/InstrumentVisitor.h
- modules/sofa/simulation/common/InstrumentVisitor.cpp
