SOFA API  8c57778a
Open source framework for multi-physics simuation
sofa::core::objectmodel::ScriptEvent Class Reference

#include <ScriptEvent.h>

Generic Event class to send a message through the simulation graph. More...

Inheritance diagram for sofa::core::objectmodel::ScriptEvent:

Detailed Description

Generic Event class to send a message through the simulation graph.

Public Member Functions

 ScriptEvent (sofa::core::sptr< sofa::core::objectmodel::BaseNode > sender, const char *eventName)
 Constructor. More...
 
 ~ScriptEvent () override
 Destructor. More...
 
const sofa::core::sptr< sofa::core::objectmodel::BaseNodegetSender (void) const
 Get the sender name. More...
 
const std::string & getEventName (void) const
 Get the event name. More...
 
- Public Member Functions inherited from sofa::core::objectmodel::Event
 Event ()
 
virtual ~Event ()
 
void setHandled ()
 Tag the event as handled, i.e. the event needs not be propagated further. More...
 
bool isHandled () const
 Returns true of the event has been handled. More...
 
virtual const chargetClassName () const
 
virtual size_t getEventTypeIndex () const =0
 

Static Public Member Functions

static const charGetClassName ()
 
- Static Public Member Functions inherited from sofa::core::objectmodel::Event
static const charGetClassName ()
 
static size_t getEventTypeCount ()
 

Additional Inherited Members

- Protected Attributes inherited from sofa::core::objectmodel::Event
bool m_handled
 
- Static Protected Attributes inherited from sofa::core::objectmodel::Event
static size_t s_lastEventTypeIndex = 0
 storing the last given id More...
 

Constructor details

◆ ScriptEvent()

sofa::core::objectmodel::ScriptEvent::ScriptEvent ( sofa::core::sptr< sofa::core::objectmodel::BaseNode sender,
const char eventName 
)

Constructor.

◆ ~ScriptEvent()

sofa::core::objectmodel::ScriptEvent::~ScriptEvent ( )
override

Destructor.

Function details

◆ GetClassName()

static const char* sofa::core::objectmodel::ScriptEvent::GetClassName ( )
inlinestatic

◆ getEventName()

const std::string& sofa::core::objectmodel::ScriptEvent::getEventName ( void  ) const
inline

Get the event name.

◆ getSender()

const sofa::core::sptr< sofa::core::objectmodel::BaseNode > sofa::core::objectmodel::ScriptEvent::getSender ( void  ) const

Get the sender name.