Collapse all Symbian^3 Product Developer Library

CMdfProcessingUnit Class Reference

class CMdfProcessingUnit : public CBase

Processing Unit interface

Inherits from

CMdfProcessingUnit
- CBase

Public Member Functions
	~CMdfProcessingUnit()
TInt	Configure(const TPuConfig &)
TInt	Create(const MMdfProcessingUnitObserver &)
TInt	CreateCustomInterface(TUid)
TAny *	CustomInterface(TUid)
void	Execute()
TInt	GetConfig(TPuConfig &)
TInt	GetInputPorts(RPointerArray< MMdfInputPort > &)
TInt	GetOutputPorts(RPointerArray< MMdfOutputPort > &)
void	Initialize()
CMdfProcessingUnit *	NewL(TUid)
TInt	Pause()
TProcessingUnitState	State()
void	Stop()

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

~CMdfProcessingUnit()

~CMdfProcessingUnit

(

)

[inline, virtual]

Destructor.

The destructor is called by ECom framework allowing derived classes to clean up the implementation specific resources.

Member Functions Documentation

Configure(const TPuConfig &)

TInt

Configure

(

const TPuConfig &

aConfigurationSetup

)

[pure virtual]

Synchronous method which sets the configuration for a Processing Unit.

Parameters

const TPuConfig & aConfigurationSetup

The reference to the structure that contains the configuration data.

Create(const MMdfProcessingUnitObserver &)

TInt

Create

(

const MMdfProcessingUnitObserver &

aProcessingUnitObserver

)

[pure virtual]

Synchronous method which creates the Processing Unit.

Parameters

const MMdfProcessingUnitObserver & aProcessingUnitObserver

The class to receive asynchronous Processing Unit events.

CreateCustomInterface(TUid)

TInt

CreateCustomInterface

(

TUid

aUid

)

[pure virtual]

Synchronous method which requests an extension feature. This is intended to provide additional features.

Parameters

TUid aUid

Used to indicate which interface is required.

CustomInterface(TUid)

TAny *

CustomInterface

(

TUid

aUid

)

[pure virtual]

Synchronous method which returns a previously created extension. This returns a custom interface. This should only be used if CreateCustomInterface() has already been called for the same UID value. This means that any construction for that interface has already been called, and thus this call cannot fail. CMdfProcessingUnit::CreateCustomInterface()

Parameters

TUid aUid

Used to indicate which interface is required.

Execute()

void

Execute

(

)

[pure virtual]

Asynchronous method which starts the execution for a Processing Unit. MMdfProcessingUnitObserver::ExecuteComplete()

GetConfig(TPuConfig &)

TInt

GetConfig

(

TPuConfig &

aConfigurationSetup

)

[pure virtual]

Synchronous method which gets a configuration structure.

Parameters

TPuConfig & aConfigurationSetup

The reference to the structure that is to contain the configuration information.

GetInputPorts(RPointerArray< MMdfInputPort > &)

TInt

GetInputPorts

(

RPointerArray< MMdfInputPort > &

aComponentInputPorts

)

[pure virtual]

Synchronous method which returns the Input Ports that a Processing Unit holds.

Parameters

RPointerArray< MMdfInputPort > & aComponentInputPorts

The array to which the Input Ports will be appended.

GetOutputPorts(RPointerArray< MMdfOutputPort > &)

TInt

GetOutputPorts

(

RPointerArray< MMdfOutputPort > &

aComponentOutputPorts

)

[pure virtual]

Synchronous method which returns the Output Ports that a Processing Unit holds.

Parameters

RPointerArray< MMdfOutputPort > & aComponentOutputPorts

The array to which the Output Ports will be appended.

Initialize()

void

Initialize

(

)

[pure virtual]

Asynchronous method which instructs the Processing Unit to start the initialization. MMdfProcessingUnitObserver::InitializeComplete()

NewL(TUid)

CMdfProcessingUnit *

NewL

(

TUid

aImplementationUid

)

[static, inline]

Standard safe constructor that leaves nothing on the cleanup stack

Parameters

TUid aImplementationUid

The uid of the new created processing unit.

Pause()

TInt

Pause

(

)

[pure virtual]

Synchronous method which pauses the current on-going task.

State()

TProcessingUnitState

State

(

)

[pure virtual]

Synchronous method which returns the current state of the Processing Unit.

Stop()

void

Stop

(

)

[pure virtual]

Synchronous method which stops the current on-going task.

Member Data Documentation

TUid iDtor_ID_Key

TUid

iDtor_ID_Key

[private]