Collapse all Symbian^3 Product Developer Library

CHWRMHapticsEffectDataGetter Class Reference

class CHWRMHapticsEffectDataGetter : public CBase

Haptics effect data getter ECom plugin interface.

hwrmhapticseffectdatagetterfw.lib

Since: S60 5.1

Inherits from

CHWRMHapticsEffectDataGetter
- CBase

Public Member Functions
	~CHWRMHapticsEffectDataGetter()
TInt	GetEffectCount(const TDesC8 &, TInt &)
TInt	GetEffectDuration(const TDesC8 &, TInt, TInt &)
TInt	GetEffectIndexFromName(const TDesC8 &, const TDesC8 &, TInt &)
TInt	GetEffectName(const TDesC8 &, TInt, TDes8 &)
TInt	GetEffectType(const TDesC8 &, TInt, TInt &)
TInt	GetMagSweepEffectDefinition(const TDesC8 &, TInt, CHWRMHaptics::THWRMHapticsMagSweepEffect &)
TInt	GetPeriodicEffectDefinition(const TDesC8 &, TInt, CHWRMHaptics::THWRMHapticsPeriodicEffect &)
IMPORT_C CHWRMHapticsEffectDataGetter *	NewL()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
TUid	iDtor_ID_Key

Constructor & Destructor Documentation

~CHWRMHapticsEffectDataGetter()

IMPORT_C

~CHWRMHapticsEffectDataGetter

(

)

[virtual]

Destructor.

Since: S60 5.1

Member Functions Documentation

GetEffectCount(const TDesC8 &, TInt &)

TInt	GetEffectCount	(	const TDesC8 &	aData,
			TInt &	aCount
		)	[pure virtual]

Returns the amount of effects in the given data.

Since: S60 5.1

Parameters

const TDesC8 & aData	The data from which the effect count is read.
TInt & aCount	Returned effect count.

GetEffectDuration(const TDesC8 &, TInt, TInt &)

TInt	GetEffectDuration	(	const TDesC8 &	aData,
			TInt	aEffectIndex,
			TInt &	aEffectDuration
		)	[pure virtual]

Returns the duration of the given effect.

Since: S60 5.1

Parameters

const TDesC8 & aData	The data from which the effect duration is read.
TInt aEffectIndex	Index of the effect.
TInt & aEffectDuration	Returned effect duration.

GetEffectIndexFromName(const TDesC8 &, const TDesC8 &, TInt &)

TInt	GetEffectIndexFromName	(	const TDesC8 &	aData,
			const TDesC8 &	aEffectName,
			TInt &	aEffectIndex
		)	[pure virtual]

Returns the effect index in the given data.

Since: S60 5.1

Parameters

const TDesC8 & aData	The data from which the effect index is read.
const TDesC8 & aEffectName	Name of the effect.
TInt & aEffectIndex	Returned effect index.

GetEffectName(const TDesC8 &, TInt, TDes8 &)

TInt	GetEffectName	(	const TDesC8 &	aData,
			TInt	aEffectIndex,
			TDes8 &	aEffectName
		)	[pure virtual]

Returns the name of the effect in the given index.

Since: S60 5.1

Parameters

const TDesC8 & aData	The data from which the effect name is read.
TInt aEffectIndex	Index of the effect.
TDes8 & aEffectName	Returned effect name.

GetEffectType(const TDesC8 &, TInt, TInt &)

TInt	GetEffectType	(	const TDesC8 &	aData,
			TInt	aEffectIndex,
			TInt &	aEffectType
		)	[pure virtual]

Returns the type of the effect.

Since: S60 5.1

Parameters

const TDesC8 & aData	The data from which the effect type is read.
TInt aEffectIndex	Index of the effect.
TInt & aEffectType	Returned effect type.

GetMagSweepEffectDefinition(const TDesC8 &, TInt, CHWRMHaptics::THWRMHapticsMagSweepEffect &)

TInt	GetMagSweepEffectDefinition	(	const TDesC8 &	aData,
			TInt	aEffectIndex,
			CHWRMHaptics::THWRMHapticsMagSweepEffect &	aEffect
		)	[pure virtual]

Returns mag sweep effect definition in the given index.

Since: S60 5.1

Parameters

const TDesC8 & aData	The data from which the effect definition is read.
TInt aEffectIndex	Index of the effect.
CHWRMHaptics::THWRMHapticsMagSweepEffect & aEffect	Returned effect data.

GetPeriodicEffectDefinition(const TDesC8 &, TInt, CHWRMHaptics::THWRMHapticsPeriodicEffect &)

TInt	GetPeriodicEffectDefinition	(	const TDesC8 &	aData,
			TInt	aEffectIndex,
			CHWRMHaptics::THWRMHapticsPeriodicEffect &	aEffect
		)	[pure virtual]

Returns periodic effect definition in the given index.

Since: S60 5.1

Parameters

const TDesC8 & aData	The data from which the effect definition is read.
TInt aEffectIndex	Index of the effect.
CHWRMHaptics::THWRMHapticsPeriodicEffect & aEffect	Returned effect data.

NewL()

IMPORT_C CHWRMHapticsEffectDataGetter *

NewL

(

)

[static]

Instantiates an object of this type. If there are no plugins found, the method leaves with KErrNotSupported. If there are more than one plugin found, the method leaves with KErrNotSupported (current implementation relies on one plugin).

Since: S60 5.1

Member Data Documentation

TUid iDtor_ID_Key

TUid

iDtor_ID_Key

[private]