sofa::simulation::DesactivationVisitor Class Reference

#include <DesactivatedNodeVisitor.h>

Inheritance diagram for sofa::simulation::DesactivationVisitor:

Inheritance graph
[legend]
Collaboration diagram for sofa::simulation::DesactivationVisitor:

Collaboration graph
[legend]

Public Member Functions

 DesactivationVisitor (bool _active=false)
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.
void setValue (bool _active)
bool getValue ()

Protected Attributes

bool active

Detailed Description

Definition at line 40 of file DesactivatedNodeVisitor.h.


Constructor & Destructor Documentation

sofa::simulation::DesactivationVisitor::DesactivationVisitor ( bool  _active = false  )  [inline]

Definition at line 44 of file DesactivatedNodeVisitor.h.


Member Function Documentation

virtual const char* sofa::simulation::DesactivationVisitor::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 DesactivatedNodeVisitor.h.

bool sofa::simulation::DesactivationVisitor::getValue (  )  [inline]

Definition at line 57 of file DesactivatedNodeVisitor.h.

References active.

virtual bool sofa::simulation::DesactivationVisitor::isThreadSafe (  )  const [inline, virtual]

Specify whether this action can be parallelized.

Reimplemented from sofa::simulation::Visitor.

Definition at line 49 of file DesactivatedNodeVisitor.h.

Visitor::Result sofa::simulation::DesactivationVisitor::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 33 of file DesactivatedNodeVisitor.cpp.

References active, sofa::core::objectmodel::Context::is_activated, sofa::simulation::Visitor::RESULT_CONTINUE, and sofa::core::objectmodel::Data< T >::setValue().

void sofa::simulation::DesactivationVisitor::setValue ( bool  _active  )  [inline]

Definition at line 56 of file DesactivatedNodeVisitor.h.

References active.


Field Documentation

Definition at line 59 of file DesactivatedNodeVisitor.h.

Referenced by getValue(), processNodeTopDown(), and setValue().


The documentation for this class was generated from the following files:

Generated on Sun Nov 23 04:24:22 2008 for Sofa by  doxygen 1.5.7.1