MHWRMHapticsActuatorObserver Class Reference

#include <hwrmhapticsactuatorobserver.h>

Link against: hwrmhapticseffectdatagetterfw.lib

class MHWRMHapticsActuatorObserver
Public Member Enumerations
enumTHWRMActuatorEvents { EHWRMActuatorAttached, EHWRMActuatorDetached, EHWRMActuatorEnabled, EHWRMActuatorDisabled, EHWRMEventLast }
Public Member Functions
pure virtual voidActuatorEventL(THWRMActuatorEvents, THWRMLogicalActuators)

Detailed Description

MHWRMHapticsActuatorObserver observer class.

A client should derive from this abstract class to receive logical actuator event notifications.

Since
S60 5.1

Member Enumeration Documentation

Enum THWRMActuatorEvents

Events that can happen to logical actuators.

EnumeratorValueDescription
EHWRMActuatorAttached

This event occurs, when an actuator plugin of a previously unsupported logical actuator type is installed to the device.

In practice, this event may occur when the user of the device starts using an external vibra device, which requires the installation of an actuator plugin currently not present in the device.

EHWRMActuatorDetached

This event occurs, when an actuator plugin of a previously supported logical actuator type is uninstalled from the device.

In practice, this event may occur when the user of the device chooses to stop using an external vibra device, and uninstalls a previously installed actuator plugin.

EHWRMActuatorEnabled

Actuator is currently enabled and it is ready to be used as normal.

Enabled/disabled state of an actuator is notified, when the actuator is opened by a client and when the state changes on runtime.

EHWRMActuatorDisabled

Actuator is currently disabled and it is not able to handle haptics commands. This state of a logical actuator is in most cases relevant only for actuator plugins handling external vibra devices; E.g. connection to the external device may be lost, in which case the plugin is not able to execute incoming commands.

EHWRMEventLast

For sanity checks only e.g. when enumerating actuator events.

Member Function Documentation

ActuatorEventL ( THWRMActuatorEvents, THWRMLogicalActuators )

voidActuatorEventL(THWRMActuatorEventsaEvent,
THWRMLogicalActuatorsaActuator
)[pure virtual]

Called when the state of an actuator changes.

Since
S60 5.1
ParameterDescription
aEventIndicates the type of event.
aActuatorLogical actuator to which the event happened.
© Nokia 2011.