CMTPMetaData Class Reference

class CMTPMetaData : public CBase

Defines the MTP meta-data base class.

Inherits from

Public Member Functions
~CMTPMetaData()
IMPORT_C TIntCompareTPathHash(const TPathHash &, const TPathHash &)
IMPORT_C const TDesC &DesC(TUint)
IMPORT_C const CDesCArray &DesCArray(TUint)
IMPORT_C TAny *GetExtendedInterface(TUid)
IMPORT_C const RArray< TPathHash > &GetHashPathArray()
IMPORT_C voidGetIntArrayL(TUint, RArray< TInt > &)
IMPORT_C voidGetUintArrayL(TUint, RArray< TUint > &)
IMPORT_C TIntInt(TUint)
IMPORT_C const RArray< TInt > &IntArray(TUint)
IMPORT_C voidSetDesCArrayL(TUint, const CDesCArrayFlat &)
IMPORT_C voidSetDesCArrayL(TUint, const CDesCArraySeg &)
IMPORT_C voidSetDesCL(TUint, const TDesC &)
IMPORT_C voidSetHashPath(const TDesC16 &, TUint)
IMPORT_C voidSetInt(TUint, TInt)
IMPORT_C voidSetIntArrayL(TUint, const RArray< TInt > &)
IMPORT_C voidSetUint(TUint, TUint)
IMPORT_C voidSetUintArrayL(TUint, const RArray< TUint > &)
IMPORT_C TUintUint(TUint)
IMPORT_C const RArray< TUint > &UintArray(TUint)
Protected Member Functions
CMTPMetaData(const TElementMetaData *, TUint)
voidConstructL()
voidConstructL(const CMTPMetaData &)
Private Member Functions
CMTPMetaData()
voidCopyL(const CDesCArray &, CDesCArray &)
voidCopyL(const RArray< TInt > &, RArray< TInt > &)
voidCopyL(const RArray< TUint > &, RArray< TUint > &)
voidDeleteIntArray(TUint)
voidDeleteUintArray(TUint)
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()
Protected Member Enumerations
enumTType {
EUndefined = 0, EDesC = 1, EDesCArray = 2, EInt = 3, EIntArray = 4, EUint = 5, EUintArray = 6
}
Private Member Enumerations
enumTDesCArrayType { EDesCArrayFlat = 0, EDesCArraySeg = 1 }
Private Attributes
const TUintKGranularity
const RArray< TElementMetaData >iElements
RPointerArray< HBufC >iElementsDesC
RPointerArray< CDesCArray >iElementsDesCArray
RArray< TInt >iElementsDesCArrayType
RArray< TInt >iElementsInt
RPointerArray< TAny >iElementsIntArray
RArray< TUint >iElementsUint
RPointerArray< TAny >iElementsUintArray
TAny *iExtensionData
TAny *iExtensionInterfaces
RArray< TPathHash >iPathHash

Constructor & Destructor Documentation

CMTPMetaData(const TElementMetaData *, TUint)

CMTPMetaData(const TElementMetaData *aElements,
TUintaCount
)[protected]

Constructor.

Parameters

const TElementMetaData * aElements
TUint aCount

CMTPMetaData()

CMTPMetaData()[private]

Default constructor.

~CMTPMetaData()

IMPORT_C~CMTPMetaData()[virtual]

Destructor.

Member Functions Documentation

CompareTPathHash(const TPathHash &, const TPathHash &)

IMPORT_C TIntCompareTPathHash(const TPathHash &,
const TPathHash &
)[static]

Parameters

const TPathHash &
const TPathHash &

ConstructL()

voidConstructL()[protected]
Second phase constructor.
leave
One of the system wide error code, if a processing failure occurs.

ConstructL(const CMTPMetaData &)

voidConstructL(const CMTPMetaData &aFrom)[protected]
Second phase copy constructor.
leave
One of the system wide error code, if a processing failure occurs.

Parameters

const CMTPMetaData & aFromThe source meta-data.

CopyL(const CDesCArray &, CDesCArray &)

voidCopyL(const CDesCArray &aFrom,
CDesCArray &aTo
)[private]
Copies the specified array contents.
leave
One of the system wide error code, if a processing failure occurs.

Parameters

const CDesCArray & aFromThe source array.
CDesCArray & aToThe target array.

CopyL(const RArray< TInt > &, RArray< TInt > &)

voidCopyL(const RArray< TInt > &aFrom,
RArray< TInt > &aTo
)[private]
Copies the specified array contents.
leave
One of the system wide error code, if a processing failure occurs.

Parameters

const RArray< TInt > & aFromThe source array.
RArray< TInt > & aToThe target array.

CopyL(const RArray< TUint > &, RArray< TUint > &)

voidCopyL(const RArray< TUint > &aFrom,
RArray< TUint > &aTo
)[private]
Copies the specified array contents.
leave
One of the system wide error code, if a processing failure occurs.

Parameters

const RArray< TUint > & aFromThe source array.
RArray< TUint > & aToThe target array.

DeleteIntArray(TUint)

voidDeleteIntArray(TUintaIdx)[private]

Deletes the specified IntArray.

Parameters

TUint aIdxThe iElementsIntArray index.

DeleteUintArray(TUint)

voidDeleteUintArray(TUintaIdx)[private]

Deletes the specified IntArray.

Parameters

TUint aIdxThe iElementsIntArray index.

DesC(TUint)

IMPORT_C const TDesC &DesC(TUintaId)const
Provides the value of the specified element.
panic
CMTPMetaData 0 In debug builds, if the specified element is not of the requested type.

Parameters

TUint aIdThe element identifier.

DesCArray(TUint)

IMPORT_C const CDesCArray &DesCArray(TUintaId)
Provides the value of the specified element.
panic
CMTPMetaData 0 In debug builds, if the specified element is not of the requested type.

Parameters

TUint aIdThe element identifier.

GetExtendedInterface(TUid)

IMPORT_C TAny *GetExtendedInterface(TUidaInterfaceUid)

Provides an MTP object manager's object meta data record extension interface implementation for the specified interface Uid.

Parameters

TUid aInterfaceUidUnique identifier for the extension interface being requested.

GetHashPathArray()

IMPORT_C const RArray< TPathHash > &GetHashPathArray()

GetIntArrayL(TUint, RArray< TInt > &)

IMPORT_C voidGetIntArrayL(TUintaId,
RArray< TInt > &aValue
)
Provides a copy of the specified element.
panic
CMTPMetaData 0 In debug builds, if the specified element is not of the requested type.
leave
One of the system wide error codes, if a processing failure occurs.

Parameters

TUint aIdThe element identifier.
RArray< TInt > & aValueOn successful completion, a copy of the element value.

GetUintArrayL(TUint, RArray< TUint > &)

IMPORT_C voidGetUintArrayL(TUintaId,
RArray< TUint > &aValue
)
Provides a copy of the specified element.
panic
CMTPMetaData 0 In debug builds, if the specified element is not of the requested type.
leave
One of the system wide error codes, if a processing failure occurs.

Parameters

TUint aIdThe element identifier.
RArray< TUint > & aValueOn successful completion, a copy of the element value.

Int(TUint)

IMPORT_C TIntInt(TUintaId)const
Provides the value of the specified element.
panic
CMTPMetaData 0 In debug builds, if the specified element is not of the requested type.

Parameters

TUint aIdThe element identifier.

IntArray(TUint)

IMPORT_C const RArray< TInt > &IntArray(TUintaId)const
Provides the value of the specified element.
panic
CMTPMetaData 0 In debug builds, if the specified element is not of the requested type.

Parameters

TUint aIdThe element identifier.

SetDesCArrayL(TUint, const CDesCArrayFlat &)

IMPORT_C voidSetDesCArrayL(TUintaId,
const CDesCArrayFlat &aValue
)
Sets the value of the specified element.
panic
CMTPMetaData 0 In debug builds, if the specified element is not of the requested type.
leave
One of the system wide error codes, if a processing failure occurs.

Parameters

TUint aIdThe element identifier.
const CDesCArrayFlat & aValueThe element value.

SetDesCArrayL(TUint, const CDesCArraySeg &)

IMPORT_C voidSetDesCArrayL(TUintaId,
const CDesCArraySeg &aValue
)
Sets the value of the specified element.
panic
CMTPMetaData 0 In debug builds, if the specified element is not of the requested type.
leave
One of the system wide error codes, if a processing failure occurs.

Parameters

TUint aIdThe element identifier.
const CDesCArraySeg & aValueThe element value.

SetDesCL(TUint, const TDesC &)

IMPORT_C voidSetDesCL(TUintaId,
const TDesC &aValue
)
Sets the value of the specified element.
panic
CMTPMetaData 0 In debug builds, if the specified element is not of the requested type.
leave
One of the system wide error codes, if a processing failure occurs.

Parameters

TUint aIdThe element identifier.
const TDesC & aValueThe element value.

SetHashPath(const TDesC16 &, TUint)

IMPORT_C voidSetHashPath(const TDesC16 &aExclusionPath,
TUintaIndex
)

Parameters

const TDesC16 & aExclusionPath
TUint aIndex

SetInt(TUint, TInt)

IMPORT_C voidSetInt(TUintaId,
TIntaValue
)
Sets the value of the specified element.
panic
CMTPMetaData 0 In debug builds, if the specified element is not of the requested type.

Parameters

TUint aIdThe element identifier.
TInt aValueThe element value.

SetIntArrayL(TUint, const RArray< TInt > &)

IMPORT_C voidSetIntArrayL(TUintaId,
const RArray< TInt > &aValue
)
Sets the value of the specified element.
panic
CMTPMetaData 0 In debug builds, if the specified element is not of the requested type.
leave
One of the system wide error codes, if a processing failure occurs.

Parameters

TUint aIdThe element identifier.
const RArray< TInt > & aValueThe element value.

SetUint(TUint, TUint)

IMPORT_C voidSetUint(TUintaId,
TUintaValue
)
Sets the value of the specified element.
panic
CMTPMetaData 0 In debug builds, if the specified element is not of the requested type.

Parameters

TUint aIdThe element identifier.
TUint aValueThe element value.

SetUintArrayL(TUint, const RArray< TUint > &)

IMPORT_C voidSetUintArrayL(TUintaId,
const RArray< TUint > &aValue
)
Sets the value of the specified element.
panic
CMTPMetaData 0 In debug builds, if the specified element is not of the requested type.
leave
One of the system wide error codes, if a processing failure occurs.

Parameters

TUint aIdThe element identifier.
const RArray< TUint > & aValueThe element value.

Uint(TUint)

IMPORT_C TUintUint(TUintaId)const
Provides the value of the specified element.
panic
CMTPMetaData 0 In debug builds, if the specified element is not of the requested type.

Parameters

TUint aIdThe element identifier.

UintArray(TUint)

IMPORT_C const RArray< TUint > &UintArray(TUintaId)const
Provides the value of the specified element.
panic
CMTPMetaData 0 In debug builds, if the specified element is not of the requested type.

Parameters

TUint aIdThe element identifier.

Member Enumerations Documentation

Enum TDesCArrayType

The CDesCArray element data type identifiers.

Enumerators

EDesCArrayFlat = 0

CDesCArrayFlat.

EDesCArraySeg = 1

CDesCArraySeg.

Enum TType

The meta-data element data type identifiers.

Enumerators

EUndefined = 0

Unknown (null).

EDesC = 1

TDesC.

EDesCArray = 2

CDesCArray.

EInt = 3

TInt.

EIntArray = 4

Rarray<TInt>.

EUint = 5

TUint.

EUintArray = 6

Rarray<TUint>.

Member Data Documentation

const TUint KGranularity

const TUintKGranularity[private, static]

The default array granularity

const RArray< TElementMetaData > iElements

const RArray< TElementMetaData >iElements[private]

The element meta-data.

RPointerArray< HBufC > iElementsDesC

RPointerArray< HBufC >iElementsDesC[private]

The DesC element data.

RPointerArray< CDesCArray > iElementsDesCArray

RPointerArray< CDesCArray >iElementsDesCArray[private]

The DesCArray element data.

RArray< TInt > iElementsDesCArrayType

RArray< TInt >iElementsDesCArrayType[private]

The TDesCArrayType type element data.

RArray< TInt > iElementsInt

RArray< TInt >iElementsInt[private]

The Int element data.

RPointerArray< TAny > iElementsIntArray

RPointerArray< TAny >iElementsIntArray[private]

The IntArray element data.

RArray< TUint > iElementsUint

RArray< TUint >iElementsUint[private]

The Uint element data.

RPointerArray< TAny > iElementsUintArray

RPointerArray< TAny >iElementsUintArray[private]

The UintArray element data.

TAny * iExtensionData

TAny *iExtensionData[private]

The extended data object pointer.

TAny * iExtensionInterfaces

TAny *iExtensionInterfaces[private]

The extended interface object pointer.

RArray< TPathHash > iPathHash

RArray< TPathHash >iPathHash[private]