mitk::EventFactory Class Reference

Generates InteractionEvent-Objects/XML. More...

#include <mitkEventFactory.h>

Static Public Member Functions
static InteractionEvent::Pointer	CreateEvent (PropertyList::Pointer eventDescription)
	Create an InteractionEvent from a property list description. More...
static std::string	EventToXML (InteractionEvent *event)
	Transform an event into an XML tag describing it. More...

Detailed Description

Generates InteractionEvent-Objects/XML.

1) InteractionEvents can be constructed by a PropertyList describing the event (see mitk::EventConfig for examples) 2) An XML description of InteractionEvents can be retrieved.

This class is used by the EventConfig object to parse configuration files and create Events based on the xml description.

Definition at line 35 of file mitkEventFactory.h.

Member Function Documentation

CreateEvent()

static InteractionEvent::Pointer mitk::EventFactory::CreateEvent ( PropertyList::Pointer  eventDescription )

static

Create an InteractionEvent from a property list description.

Parses the PropertyList and queries all possible information. If an attribute is not present the default value is used. Finally the Event-Type is chosen by the ClassName property and the object is created using the collected information.

Parameters

eventDescription

A PropertyList describing the event attributes.

Returns

A newly created InteractionEvent, or nullptr if creation failed.

See also

EventConfig

EventToXML()

static std::string mitk::EventFactory::EventToXML ( InteractionEvent *  event )

static

Transform an event into an XML tag describing it.

Parameters

event

The InteractionEvent to serialize.

Returns

XML string block specifying the event class and attributes.

---

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

• mitkEventFactory.h