sofa::core::objectmodel::Event Class Reference

Base class for all events received by the objects. More...

#include <Event.h>

Inheritance diagram for sofa::core::objectmodel::Event:

[legend]

Collaboration diagram for sofa::core::objectmodel::Event:

[legend]

Public Member Functions
	Event ()
virtual	~Event ()
void	setHandled ()
	Tag the event as handled, i.e. the event needs not be propagated further.
bool	isHandled () const
	Returns true of the event has been handled.
Protected Attributes
bool	m_handled

---

Detailed Description

Base class for all events received by the objects.

When created, the status is initialized as not handled. It is then propagated along the objects until it is handled.

Author:

Francois Faure

Definition at line 46 of file Event.h.

---

Constructor & Destructor Documentation

sofa::core::objectmodel::Event::Event

(

)

Definition at line 49 of file Event.cpp.

References m_handled.

sofa::core::objectmodel::Event::~Event

(

)

[virtual]

Definition at line 55 of file Event.cpp.

---

Member Function Documentation

bool sofa::core::objectmodel::Event::isHandled

(

)

const

Returns true of the event has been handled.

Definition at line 63 of file Event.cpp.

References m_handled.

Referenced by sofa::simulation::PropagateEventVisitor::processNodeTopDown().

void sofa::core::objectmodel::Event::setHandled

(

)

Tag the event as handled, i.e. the event needs not be propagated further.

Definition at line 59 of file Event.cpp.

References m_handled.

---

Field Documentation

bool sofa::core::objectmodel::Event::m_handled [protected]

Definition at line 59 of file Event.h.

Referenced by Event(), isHandled(), and setHandled().

---

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

• framework/sofa/core/objectmodel/Event.h
• framework/sofa/core/objectmodel/Event.cpp