Symbian^3 Application Developer Library >

CMTPTypeServicePropListElement Class Reference

class CMTPTypeServicePropListElement : public CMTPTypeCompoundBase

Defines the MTP ObjectPropList element dataset. The ObjectPropList element dataset describes an object property with a meta data triplet and a value. It is a component element of the ObjectPropList dataset.

Inherits from

Public Member Functions
~CMTPTypeServicePropListElement ()
IMPORT_C MMTPType * CommitChunkL ( TPtr8 &)
IMPORT_C TBool CommitRequired ()
IMPORT_C TInt FirstWriteChunk ( TPtr8 &)
IMPORT_C CMTPTypeServicePropListElement * NewL ( TUint16 )
IMPORT_C CMTPTypeServicePropListElement * NewL ( TUint32 , TUint16 , const MMTPType &)
IMPORT_C CMTPTypeServicePropListElement * NewL ( TUint16 , TUint16 )
IMPORT_C CMTPTypeServicePropListElement * NewL ( TUint32 , TUint16 , TUint16 , const MMTPType &)
IMPORT_C CMTPTypeServicePropListElement * NewLC ( TUint16 )
IMPORT_C CMTPTypeServicePropListElement * NewLC ( TUint32 , TUint16 , const MMTPType &)
IMPORT_C CMTPTypeServicePropListElement * NewLC ( TUint16 , TUint16 )
IMPORT_C CMTPTypeServicePropListElement * NewLC ( TUint32 , TUint16 , TUint16 , const MMTPType &)
IMPORT_C TUint Type ()
Private Member Functions
CMTPTypeServicePropListElement ()
void ConstructL ()
void ConstructL ( TUint16 , TUint16 , const TUint32 *, const MMTPType *)
void DestroyChunks ()
const TElementInfo & ElementInfo ( TInt )
CMTPTypeServicePropListElement * NewLC ()
TBool WriteableElementL ( 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()
CMTPTypeCompoundBase::CMTPTypeCompoundBase(TBool,TUint)
CMTPTypeCompoundBase::ChunkAppendL(const MMTPType &)
CMTPTypeCompoundBase::ChunkCount()const
CMTPTypeCompoundBase::ChunkRemove(TUint)
CMTPTypeCompoundBase::FirstReadChunk(TPtrC8 &)const
CMTPTypeCompoundBase::GetL(TInt,MMTPType &)const
CMTPTypeCompoundBase::Int16L(TInt)const
CMTPTypeCompoundBase::Int32L(TInt)const
CMTPTypeCompoundBase::Int64L(TInt)const
CMTPTypeCompoundBase::Int8L(TInt)const
CMTPTypeCompoundBase::NextReadChunk(TPtrC8 &)const
CMTPTypeCompoundBase::NextWriteChunk(TPtr8 &)
CMTPTypeCompoundBase::NextWriteChunk(TPtr8 &,TUint)
CMTPTypeCompoundBase::ReadableElementL(TInt)const
CMTPTypeCompoundBase::Reset()
CMTPTypeCompoundBase::SetExpectedChunkCount(TUint)
CMTPTypeCompoundBase::SetInt16L(TInt,TInt16)
CMTPTypeCompoundBase::SetInt32L(TInt,TInt32)
CMTPTypeCompoundBase::SetInt64L(TInt,TInt64)
CMTPTypeCompoundBase::SetInt8L(TInt,TInt8)
CMTPTypeCompoundBase::SetL(TInt,const MMTPType &)
CMTPTypeCompoundBase::SetStringL(TInt,const TDesC &)
CMTPTypeCompoundBase::SetUint16L(TInt,TUint16)
CMTPTypeCompoundBase::SetUint32L(TInt,TUint32)
CMTPTypeCompoundBase::SetUint64L(TInt,TUint64)
CMTPTypeCompoundBase::SetUint8L(TInt,TUint8)
CMTPTypeCompoundBase::Size()const
CMTPTypeCompoundBase::StringCharsL(TInt)const
CMTPTypeCompoundBase::StringNumCharsL(TInt)const
CMTPTypeCompoundBase::Uint16L(TInt)const
CMTPTypeCompoundBase::Uint32L(TInt)const
CMTPTypeCompoundBase::Uint64L(TInt)const
CMTPTypeCompoundBase::Uint8L(TInt)const
CMTPTypeCompoundBase::Validate()const
CMTPTypeCompoundBase::ValidateChunkCount()const
CMTPTypeCompoundBase::~CMTPTypeCompoundBase()
Public Member Enumerations
enum TMTPObjectPropListElement { EObjectHandle , EPropertyCode , EDatatype , EValue , ENumElements }
Private Member Enumerations
enum TChunkIds { EIdFlatChunk , EIdValueChunk , EIdNumChunks }
enum TWriteSequenceState { EIdle , EFlatChunk , EValueChunk }
Inherited Enumerations
CMTPTypeCompoundBase:TReadWriteSequenceState
Private Attributes
const TUint KFlatChunkSize
RMTPTypeCompoundFlatChunk iChunkFlat
RMTPType iChunkValue
const TFixedArray < TElementInfo , ENumElements > iElementInfo
const TElementInfo iElementMetaData
TBool iInitialised
TUint iWriteSequenceState
Inherited Attributes
CMTPTypeCompoundBase::KJustInTimeConstruction
CMTPTypeCompoundBase::KMTPNotApplicable
CMTPTypeCompoundBase::KVariableChunkCount
CMTPTypeCompoundBase::iChunks
CMTPTypeCompoundBase::iWriteChunk

Constructor & Destructor Documentation

CMTPTypeServicePropListElement()

CMTPTypeServicePropListElement ( ) [private]

~CMTPTypeServicePropListElement()

IMPORT_C ~CMTPTypeServicePropListElement ( ) [virtual]

Destructor.

Member Functions Documentation

CommitChunkL(TPtr8 &)

IMPORT_C MMTPType * CommitChunkL ( TPtr8 & aChunk ) [virtual]

Parameters

TPtr8 & aChunk

CommitRequired()

IMPORT_C TBool CommitRequired ( ) const [virtual]

ConstructL()

void ConstructL ( ) [private]

ConstructL(TUint16, TUint16, const TUint32 *, const MMTPType *)

void ConstructL ( TUint16 aPropertyCode,
TUint16 aDataType,
const TUint32 * aObjectHandle,
const MMTPType * aValue
) [private]

Parameters

TUint16 aPropertyCode
TUint16 aDataType
const TUint32 * aObjectHandle
const MMTPType * aValue

DestroyChunks()

void DestroyChunks ( ) [private]

ElementInfo(TInt)

const TElementInfo & ElementInfo ( TInt aElementId ) const [private, virtual]

Provides the TElementInfo data for the specified element.

Parameters

TInt aElementId The identifier of the requested element.

FirstWriteChunk(TPtr8 &)

IMPORT_C TInt FirstWriteChunk ( TPtr8 & aChunk ) [virtual]

Parameters

TPtr8 & aChunk

NewL(TUint16)

IMPORT_C CMTPTypeServicePropListElement * NewL ( TUint16 aPropertyCode ) [static]
MTP ObjectPropList element dataset factory method. This method is used to create an MTP ObjectPropList element dataset type with the default ElementDataType defined for the specified ElementPropertyCode, and the default ElementObjectHandle and ElementValue values.
leave
One of the system wide error codes, if unsuccessful.

Parameters

TUint16 aPropertyCode The datacode identifying the ObjectPropDesc which describes the property.

NewL(TUint32, TUint16, const MMTPType &)

IMPORT_C CMTPTypeServicePropListElement * NewL ( TUint32 aObjectHandle,
TUint16 aPropertyCode,
const MMTPType & aValue
) [static]
MTP ObjectPropList element dataset factory method. This method is used to create an MTP ObjectPropList element dataset type with with the default ElementDataType defined for the specified ElementPropertyCode, and the specified ElementObjectHandle and ElementValue values.
leave
One of the system wide error codes, if unsuccessful.

Parameters

TUint32 aObjectHandle The ObjectHandle of the object to which the property applies.
TUint16 aPropertyCode The datacode identifying the ObjectPropDesc which describes the property.
const MMTPType & aValue The value of the property.

NewL(TUint16, TUint16)

IMPORT_C CMTPTypeServicePropListElement * NewL ( TUint16 aPropertyCode,
TUint16 aDataType
) [static]
MTP ObjectPropList element dataset factory method. This method is used to create an MTP ObjectPropList element dataset type with the specified ElementPropertyCode and ElementDataType values, and the default ElementObjectHandle and ElementValue values.
leave
One of the system wide error codes, if unsuccessful.

Parameters

TUint16 aPropertyCode The datacode identifying the ObjectPropDesc which describes the property.
TUint16 aDataType The datacode identifying the datatype of the property.

NewL(TUint32, TUint16, TUint16, const MMTPType &)

IMPORT_C CMTPTypeServicePropListElement * NewL ( TUint32 aObjectHandle,
TUint16 aPropertyCode,
TUint16 aDataType,
const MMTPType & aValue
) [static]
MTP ObjectPropList element dataset factory method. This method is used to create an MTP ObjectPropList element dataset type with the specified values.
leave
One of the system wide error codes, if unsuccessful.

Parameters

TUint32 aObjectHandle The ObjectHandle of the object to which the property applies.
TUint16 aPropertyCode The datacode identifying the ObjectPropDesc which describes the property.
TUint16 aDataType The datacode identifying the datatype of the property.
const MMTPType & aValue The value of the property.

NewLC(TUint16)

IMPORT_C CMTPTypeServicePropListElement * NewLC ( TUint16 aPropertyCode ) [static]
MTP ObjectPropList element dataset factory method. This method is used to create an MTP ObjectPropList element dataset type with with the default ElementDataType defined for the specified ElementPropertyCode, and the default ElementObjectHandle and ElementValue values. A pointer to the data type is placed on the cleanup stack.
leave
One of the system wide error codes, if unsuccessful.

Parameters

TUint16 aPropertyCode The datacode identifying the ObjectPropDesc which describes the property.

NewLC(TUint32, TUint16, const MMTPType &)

IMPORT_C CMTPTypeServicePropListElement * NewLC ( TUint32 aObjectHandle,
TUint16 aPropertyCode,
const MMTPType & aValue
) [static]
MTP ObjectPropList element dataset factory method. This method is used to create an MTP ObjectPropList element dataset type with with the default ElementDataType defined for the specified ElementPropertyCode, and the specified ElementObjectHandle and ElementValue values. A pointer to the data type is placed on the cleanup stack.
leave
One of the system wide error codes, if unsuccessful.

Parameters

TUint32 aObjectHandle The ObjectHandle of the object to which the property applies.
TUint16 aPropertyCode The datacode identifying the ObjectPropDesc which describes the property.
const MMTPType & aValue The value of the property.

NewLC(TUint16, TUint16)

IMPORT_C CMTPTypeServicePropListElement * NewLC ( TUint16 aPropertyCode,
TUint16 aDataType
) [static]
MTP ObjectPropList element dataset factory method. This method is used to create an MTP ObjectPropList element dataset type with the specified ElementPropertyCode and ElementDataType values, and the default ElementObjectHandle and ElementValue values. A pointer to the data type is placed on the cleanup stack.
leave
One of the system wide error codes, if unsuccessful.

Parameters

TUint16 aPropertyCode The datacode identifying the ObjectPropDesc which describes the property.
TUint16 aDataType The datacode identifying the datatype of the property.

NewLC(TUint32, TUint16, TUint16, const MMTPType &)

IMPORT_C CMTPTypeServicePropListElement * NewLC ( TUint32 aObjectHandle,
TUint16 aPropertyCode,
TUint16 aDataType,
const MMTPType & aValue
) [static]
MTP ObjectPropList element dataset factory method. This method is used to create an MTP ObjectPropList element dataset type with the specified values. A pointer to the data type is placed on the cleanup stack.
leave
One of the system wide error codes, if unsuccessful.

Parameters

TUint32 aObjectHandle The ObjectHandle of the object to which the property applies.
TUint16 aPropertyCode The datacode identifying the ObjectPropDesc which describes the property.
TUint16 aDataType The datacode identifying the datatype of the property.
const MMTPType & aValue The value of the property.

NewLC()

CMTPTypeServicePropListElement * NewLC ( ) [private, static]

Type()

IMPORT_C TUint Type ( ) const [virtual]

WriteableElementL(TInt)

TBool WriteableElementL ( TInt aElementId ) const [private, virtual]

Indicates if the specified element can be written to.

Parameters

TInt aElementId The identifier of the requested element.

Member Enumerations Documentation

Enum TChunkIds

Data chunk identifiers.

Enumerators

EIdFlatChunk

The flat data chunk ID.

EIdValueChunk

The EValue element data chunk ID.

EIdNumChunks

The number of data chunks.

Enum TMTPObjectPropListElement

MTP ObjectPropList property quadruple dataset element identifiers.

Enumerators

EObjectHandle

The ObjectHandle of the object to which the property applies.

EPropertyCode

The ObjectPropDesc property identifier datacode (read-only).

EDatatype

The datatype code of the property (read-only).

EValue

The value of the property.

ENumElements

The number of dataset elements.

Enum TWriteSequenceState

The write data stream states.

Enumerators

EIdle

Data stream is inactive.

EFlatChunk

Streaming the property descriptor triplet dataset data chunk.

EValueChunk

Streaming the property value data chunk.

Member Data Documentation

const TUint KFlatChunkSize

const TUint KFlatChunkSize [private, static]

The property meta data triplet flat data chunk size in bytes.

RMTPTypeCompoundFlatChunk iChunkFlat

RMTPTypeCompoundFlatChunk iChunkFlat [private]

The property meta data flat data chunk, comprising elements EObjectHandle to EDatatype.

RMTPType iChunkValue

RMTPType iChunkValue [private]

The EValue data chunk.

const TFixedArray< TElementInfo, ENumElements > iElementInfo

const TFixedArray < TElementInfo , ENumElements > iElementInfo [private]

The dataset element metadata table.

const TElementInfo iElementMetaData

const TElementInfo iElementMetaData [private, static]

The dataset element metadata table content.

TBool iInitialised

TBool iInitialised [private]

The initialised flag indicating if construction is complete and that read-only elements can no longer be modified.

TUint iWriteSequenceState

TUint iWriteSequenceState [private]

The write data stream state variable.

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.