Symbian^3 Application Developer Library >

CMTPTypeObjectPropDescEnumerationForm Class Reference

class CMTPTypeObjectPropDescEnumerationForm : public CMTPTypeCompoundBase

Defines the MTP ObjectPropDesc Enumeration FORM dataset. The Enumeration FORM dataset is a component element of the ObjectPropDesc dataset. CMTPTypeObjectPropDesc

Inherits from

Public Member Functions
~CMTPTypeObjectPropDescEnumerationForm ()
IMPORT_C void AppendSupportedValueL (const MMTPType &)
IMPORT_C MMTPType * CommitChunkL ( TPtr8 &)
IMPORT_C TBool CommitRequired ()
IMPORT_C TInt FirstWriteChunk ( TPtr8 &)
IMPORT_C CMTPTypeObjectPropDescEnumerationForm * NewL ( TUint )
IMPORT_C CMTPTypeObjectPropDescEnumerationForm * NewLC ( TUint )
IMPORT_C TInt NextWriteChunk ( TPtr8 &)
IMPORT_C TUint16 NumberOfValues ()
IMPORT_C void SupportedValueL ( TUint , MMTPType &)
IMPORT_C TUint Type ()
Private Member Functions
CMTPTypeObjectPropDescEnumerationForm ( TUint )
void AppendValueChunkL ()
void ConstructL ()
const TElementInfo & ElementInfo ( TInt )
TInt ValidateChunkCount ()
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 &,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::WriteableElementL(TInt)const
CMTPTypeCompoundBase::~CMTPTypeCompoundBase()
Private Member Enumerations
enum TReadWriteSequenceState { EIdle , EInProgress }
Private Attributes
const TUint KNumberOfValuesChunk
const TUint KValueChunks
TMTPTypeUint16 iChunkNumberOfValues
RArray < RMTPType > iChunksValue
CMTPTypeCompoundBase::TElementInfo iInfoNumberOfValues
CMTPTypeCompoundBase::TElementInfo iInfoValue
TUint iWriteSequenceState
Inherited Attributes
CMTPTypeCompoundBase::KJustInTimeConstruction
CMTPTypeCompoundBase::KMTPNotApplicable
CMTPTypeCompoundBase::KVariableChunkCount
CMTPTypeCompoundBase::iChunks
CMTPTypeCompoundBase::iWriteChunk

Constructor & Destructor Documentation

CMTPTypeObjectPropDescEnumerationForm(TUint)

CMTPTypeObjectPropDescEnumerationForm ( TUint aDataType ) [private]

Parameters

TUint aDataType

~CMTPTypeObjectPropDescEnumerationForm()

IMPORT_C ~CMTPTypeObjectPropDescEnumerationForm ( ) [virtual]

Destructor.

Member Functions Documentation

AppendSupportedValueL(const MMTPType &)

IMPORT_C void AppendSupportedValueL ( const MMTPType & aValue )
Appends the specified value to the set of supported enumeration values.
leave
One of the system wide error codes, if unsuccessful.
panic
MTPDataTypes 3, if the source value type does not match the property data type.

Parameters

const MMTPType & aValue The enumeration value to append.

AppendValueChunkL()

void AppendValueChunkL ( ) [private]

CommitChunkL(TPtr8 &)

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

Parameters

TPtr8 & aChunk

CommitRequired()

IMPORT_C TBool CommitRequired ( ) const [virtual]

ConstructL()

void ConstructL ( ) [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(TUint)

IMPORT_C CMTPTypeObjectPropDescEnumerationForm * NewL ( TUint aDataType ) [static]
MTP ObjectPropDesc Enumeration FORM dataset factory method. This method is used to create an empty MTP ObjectPropDesc FORM dataset of the specified Datatype.
leave
One of the system wide error codes, if unsuccessful.

Parameters

TUint aDataType The data type identifier datacode of the dataset.

NewLC(TUint)

IMPORT_C CMTPTypeObjectPropDescEnumerationForm * NewLC ( TUint aDataType ) [static]
MTP ObjectPropDesc Enumeration FORM dataset factory method. This method is used to create an empty MTP ObjectPropDesc FORM dataset of the specified Datatype. A pointer to the data type is placed on the cleanup stack.
leave
One of the system wide error codes, if unsuccessful.

Parameters

TUint aDataType The data type identifier datacode of the dataset.

NextWriteChunk(TPtr8 &)

IMPORT_C TInt NextWriteChunk ( TPtr8 & aChunk ) [virtual]

Parameters

TPtr8 & aChunk

NumberOfValues()

IMPORT_C TUint16 NumberOfValues ( ) const

Provides the NumberOfValues element value.

SupportedValueL(TUint, MMTPType &)

IMPORT_C void SupportedValueL ( TUint aIndex,
MMTPType & aValue
) const
Provides the SupportedValue element at the specified index.
leave
One of the system wide error codes, if unsuccessful.
panic
MTPDataTypes 3, if the target value type does not match the property data type.

Parameters

TUint aIndex The index of the required value.
MMTPType & aValue On successful completion, the requested value.

Type()

IMPORT_C TUint Type ( ) const [virtual]

ValidateChunkCount()

TInt ValidateChunkCount ( ) const [private, virtual]

Validates that the number of chunks making up the compound type is valid. This method is invoked on variable length compound types by the default Valid implementation. Valid KVariableChunkCount

Member Enumerations Documentation

Enum TReadWriteSequenceState

The write data stream states.

Enumerators

EIdle

Data stream is inactive.

EInProgress

Data stream is in progress.

Member Data Documentation

const TUint KNumberOfValuesChunk

const TUint KNumberOfValuesChunk [private, static]

The NumberOfValues element data chunk ID.

const TUint KValueChunks

const TUint KValueChunks [private, static]

The SupportedValue array elements metadata content. Note that this is declared mutable to allow state updates while processing a read data stream.

TMTPTypeUint16 iChunkNumberOfValues

TMTPTypeUint16 iChunkNumberOfValues [private]

The NumberOfPropDescs element data chunk.

RArray< RMTPType > iChunksValue

RArray < RMTPType > iChunksValue [private]

The SupportedValue elements array data chunks.

CMTPTypeCompoundBase::TElementInfo iInfoNumberOfValues

CMTPTypeCompoundBase::TElementInfo iInfoNumberOfValues [private]

The NumberOfValues element metadata content.

CMTPTypeCompoundBase::TElementInfo iInfoValue

CMTPTypeCompoundBase::TElementInfo iInfoValue [private]

The SupportedValue array elements metadata content. Note that this is declared mutable to allow state updates while processing a read data stream.

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.