Symbian^3 Application Developer Library >

CCdlInstance Class Reference

class CCdlInstance : public CCdlEngineRef

The abstract base class for all customisation instance objects. Only the CDL engine can create objects derived from this class.

Inherits from

Public Member Functions
TAny * Extension ( TInt )
IMPORT_C void FileNameRelativeToLastAccessedInstance ( TFileName &)
IMPORT_C TAny * GetData ( TInt )
IMPORT_C TCdlEngineFunc * GetFunction ( TInt )
TAny * Implementation ( TInt )
const CCdlInstance * Implementor ( TInt )
const SCdlInterface & Interface ()
TBool IsComplete ()
IMPORT_C const TCdlRef & LastAccessedRef ()
IMPORT_C CCdlInstance * NewL (const TCdlRef &, const SCdlInterface *, const CCdlInstance *, CCdlEngine *, TInt *)
IMPORT_C CCdlInstance * NewLC (const TCdlRef &, const SCdlInterface *, const CCdlInstance *, CCdlEngine *, TInt *)
IMPORT_C const TCdlRef & Ref ()
IMPORT_C const CCdlInstance * SubLayer ()
IMPORT_C TBool operator== (const CCdlInstance &)
Protected Member Functions
CCdlInstance ( CCdlEngine *, TInt *)
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()
CCdlEngineRef::AddRef()
CCdlEngineRef::CCdlEngineRef(CCdlEngineBase *)
CCdlEngineRef::Engine()const
CCdlEngineRef::ReleaseRef()
CCdlEngineRef::~CCdlEngineRef()
Protected Attributes
TInt & iLastApi
TCdlRef iRef
const CCdlInstance * iSubLayer

Constructor & Destructor Documentation

CCdlInstance(CCdlEngine *, TInt *)

CCdlInstance ( CCdlEngine * aEngine,
TInt * aLastApi
) [protected]

Parameters

CCdlEngine * aEngine
TInt * aLastApi

Member Functions Documentation

Extension(TInt)

TAny * Extension ( TInt aId ) const [virtual]

Parameters

TInt aId

FileNameRelativeToLastAccessedInstance(TFileName &)

IMPORT_C void FileNameRelativeToLastAccessedInstance ( TFileName & aFileName ) const

Adjusts a filename to be relative to the file containing the CDL instance that implemented the last accessed API. The filename will be made relative to this instances file, or the file of one of this instances sub-layers.

Parameters

TFileName & aFileName the filename to be adjusted.

GetData(TInt)

IMPORT_C TAny * GetData ( TInt aCdlApiId ) const

Parameters

TInt aCdlApiId

GetFunction(TInt)

IMPORT_C TCdlEngineFunc * GetFunction ( TInt aCdlApiId ) const

Parameters

TInt aCdlApiId

Implementation(TInt)

TAny * Implementation ( TInt aCdlApiId ) const [pure virtual]

Parameters

TInt aCdlApiId

Implementor(TInt)

const CCdlInstance * Implementor ( TInt aCdlApiId ) const

Parameters

TInt aCdlApiId

Interface()

const SCdlInterface & Interface ( ) const [pure virtual]

IsComplete()

TBool IsComplete ( ) const [pure virtual]

Does this instance implement all of it's API? Instances that don't implement their entire API need a sub-layer that does implement the entire API.

LastAccessedRef()

IMPORT_C const TCdlRef & LastAccessedRef ( ) const

The CDL instance reference for the instance that actually implemented the last accessed API. If this instance implemented the API, then this instance's reference will be returned. Otherwise it will be the reference of one of this instance's sub-layers.

NewL(const TCdlRef &, const SCdlInterface *, const CCdlInstance *, CCdlEngine *, TInt *)

IMPORT_C CCdlInstance * NewL ( const TCdlRef & aRef,
const SCdlInterface * aInterfaceParams,
const CCdlInstance * aSubLayer = NULL,
CCdlEngine * aEngine = NULL,
TInt * aLastApi = NULL
) [static]

Parameters

const TCdlRef & aRef
const SCdlInterface * aInterfaceParams
const CCdlInstance * aSubLayer = NULL
CCdlEngine * aEngine = NULL
TInt * aLastApi = NULL

NewLC(const TCdlRef &, const SCdlInterface *, const CCdlInstance *, CCdlEngine *, TInt *)

IMPORT_C CCdlInstance * NewLC ( const TCdlRef & aRef,
const SCdlInterface * aInterfaceParams,
const CCdlInstance * aSubLayer = NULL,
CCdlEngine * aEngine = NULL,
TInt * aLastApi = NULL
) [static]

Parameters

const TCdlRef & aRef
const SCdlInterface * aInterfaceParams
const CCdlInstance * aSubLayer = NULL
CCdlEngine * aEngine = NULL
TInt * aLastApi = NULL

Ref()

IMPORT_C const TCdlRef & Ref ( ) const

Gets the CDL instance reference for this instance

SubLayer()

IMPORT_C const CCdlInstance * SubLayer ( ) const

Gets the instance that forms the sub-layer for this instance. Any API not implemented by this instance will be implemented in a sub-layer.

operator==(const CCdlInstance &)

IMPORT_C TBool operator== ( const CCdlInstance & aOther ) const

Test whether this instance is the same as another.

Parameters

const CCdlInstance & aOther the instance you want to compare with this one.

Member Data Documentation

TInt & iLastApi

TInt & iLastApi [protected]

TCdlRef iRef

TCdlRef iRef [protected]

const CCdlInstance * iSubLayer

const CCdlInstance * iSubLayer [protected]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.