sofa::simulation::PropagateEventVisitor Class Reference

Visitor used to propagate an event in the the data structure. More...

#include <PropagateEventVisitor.h>

Inheritance diagram for sofa::simulation::PropagateEventVisitor:

[legend]

Collaboration diagram for sofa::simulation::PropagateEventVisitor:

[legend]

Public Member Functions
	PropagateEventVisitor (sofa::core::objectmodel::Event *e)
	~PropagateEventVisitor ()
Visitor::Result	processNodeTopDown (simulation::Node *node)
	Callback method called when decending to a new node. Recursion will stop if this method returns RESULT_PRUNE.
void	processObject (simulation::Node *, core::objectmodel::BaseObject *obj)
Protected Attributes
sofa::core::objectmodel::Event *	m_event

---

Detailed Description

Visitor used to propagate an event in the the data structure.

Propagation is done top-down until the event is handled.

Author:

The SOFA team </www.sofa-framework.org>

Definition at line 54 of file PropagateEventVisitor.h.

---

Constructor & Destructor Documentation

sofa::simulation::PropagateEventVisitor::PropagateEventVisitor

(

sofa::core::objectmodel::Event *

e

)

Definition at line 45 of file PropagateEventVisitor.cpp.

sofa::simulation::PropagateEventVisitor::~PropagateEventVisitor

(

)

Definition at line 51 of file PropagateEventVisitor.cpp.

---

Member Function Documentation

Visitor::Result sofa::simulation::PropagateEventVisitor::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 54 of file PropagateEventVisitor.cpp.

References sofa::simulation::Visitor::for_each(), sofa::core::objectmodel::Event::isHandled(), m_event, sofa::simulation::Node::object, processObject(), sofa::simulation::Visitor::RESULT_CONTINUE, and sofa::simulation::Visitor::RESULT_PRUNE.

void sofa::simulation::PropagateEventVisitor::processObject	(	simulation::Node *	,
		core::objectmodel::BaseObject *	obj
	)

Definition at line 63 of file PropagateEventVisitor.cpp.

References sofa::core::objectmodel::BaseObject::f_listening, sofa::core::objectmodel::Data< T >::getValue(), sofa::core::objectmodel::BaseObject::handleEvent(), and m_event.

Referenced by processNodeTopDown().

---

Field Documentation

sofa::core::objectmodel::Event* sofa::simulation::PropagateEventVisitor::m_event [protected]

Definition at line 65 of file PropagateEventVisitor.h.

Referenced by processNodeTopDown(), and processObject().

---

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

• modules/sofa/simulation/common/PropagateEventVisitor.h
• modules/sofa/simulation/common/PropagateEventVisitor.cpp