Collapse all Symbian^3 Application Developer Library

CMTPTypeServicePropDesc Class Reference

class CMTPTypeServicePropDesc : public CMTPTypeCompoundBase

Defines the MTP Service Property Description dataset. The dataset is a component element of the CMTPTypeServicePropDescList . CMTPTypeObjectPropDesc

Inherits from

CMTPTypeServicePropDesc
- CMTPTypeCompoundBase
  - CBase

Public Member Functions
	~CMTPTypeServicePropDesc ()
IMPORT_C MMTPType *	CommitChunkL ( TPtr8 &)
IMPORT_C TBool	CommitRequired ()
IMPORT_C TInt	FirstWriteChunk ( TPtr8 &)
IMPORT_C CMTPTypeServicePropDesc *	NewL ()
IMPORT_C CMTPTypeServicePropDesc *	NewL (const TUint16 , const TUint16 , const TUint8 , const TUint8 , const MMTPType *)
IMPORT_C CMTPTypeServicePropDesc *	NewLC ()
IMPORT_C CMTPTypeServicePropDesc *	NewLC (const TUint16 , const TUint16 , const TUint8 , const TUint8 , const MMTPType *)
IMPORT_C TInt	NextWriteChunk ( TPtr8 &)
IMPORT_C TUint	Type ()

Private Member Functions
	CMTPTypeServicePropDesc ()
void	ConstructL (const TUint16 , const TUint16 , const TUint8 , const TUint8 , const MMTPType *)
const TElementInfo &	ElementInfo ( TInt )
TBool	HasFormField ( TUint8 )

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::ValidateChunkCount()const
	CMTPTypeCompoundBase::WriteableElementL(TInt)const
	CMTPTypeCompoundBase::~CMTPTypeCompoundBase()

Public Member Enumerations
enum	TMTPObjectPropDescElement { EServicePropertyCode , EDataType1 , EGetSet1 , EFormFlag , EForm , ENumElements }
enum	TMTPServicePropDescGetSet { EReadOnly = 0x00, EReadWrite = 0x01 }

Private Member Enumerations
enum	TChunkIds { EIdFlat1Chunk , EIdFormChunk , EIdNumChunks }
enum	TReadWriteSequenceState { EIdle , EFormChunk }

Private Attributes
const TUint	KFlat1ChunkSize
const TUint	KNumChunksWithForm
const TUint	KNumChunksWithoutForm
RMTPTypeCompoundFlatChunk	iChunkFlat1
CMTPTypeObjectPropDesc::RMTPTypeObjectPropDescForm	iChunkForm
const TFixedArray < TElementInfo , ENumElements >	iElementInfo
const CMTPTypeCompoundBase::TElementInfo	iElementMetaData
TUint	iWriteSequenceCompletionState
TUint	iWriteSequenceState

Inherited Attributes
	CMTPTypeCompoundBase::KJustInTimeConstruction
	CMTPTypeCompoundBase::KMTPNotApplicable
	CMTPTypeCompoundBase::KVariableChunkCount
	CMTPTypeCompoundBase::iChunks
	CMTPTypeCompoundBase::iWriteChunk

Constructor & Destructor Documentation

CMTPTypeServicePropDesc()

CMTPTypeServicePropDesc

(

)

[private]

~CMTPTypeServicePropDesc()

IMPORT_C

~CMTPTypeServicePropDesc

(

)

[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(const TUint16, const TUint16, const TUint8, const TUint8, const MMTPType *)

void	ConstructL	(	const TUint16	aServicePropCode,
			const TUint16	aDataType,
			const TUint8	aGetSet,
			const TUint8	aFormFlag,
			const MMTPType *	aForm
		)	[private]

Parameters

const TUint16 aServicePropCode
const TUint16 aDataType
const TUint8 aGetSet
const TUint8 aFormFlag
const MMTPType * aForm

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

HasFormField(TUint8)

TBool

HasFormField

(

TUint8

aFormFlag

)

const [private]

Parameters

TUint8 aFormFlag

NewL()

IMPORT_C CMTPTypeServicePropDesc *

NewL

(

)

[static]

MTP Service Object Property Extension FORM dataset factory method. This method is used to create an empty MTP Service Object Property Extension FORM of the specified Datatype.

leave: One of the system wide error codes, if unsuccessful.

NewL(const TUint16, const TUint16, const TUint8, const TUint8, const MMTPType *)

IMPORT_C CMTPTypeServicePropDesc *	NewL	(	const TUint16	aServicePropCode,
			const TUint16	aDataType,
			const TUint8	aGetSet,
			const TUint8	aFormFlag,
			const MMTPType *	aForm
		)	[static]

Parameters

const TUint16 aServicePropCode
const TUint16 aDataType
const TUint8 aGetSet
const TUint8 aFormFlag
const MMTPType * aForm

NewLC()

IMPORT_C CMTPTypeServicePropDesc *

NewLC

(

)

[static]

MTP DevicePropDesc Service Object Property Extension FORM factory method. This method is used to create an empty MTP Service Object Property Extension FORM of the specified Datatype.

leave: One of the system wide error codes, if unsuccessful.

NewLC(const TUint16, const TUint16, const TUint8, const TUint8, const MMTPType *)

IMPORT_C CMTPTypeServicePropDesc *	NewLC	(	const TUint16	aServicePropCode,
			const TUint16	aDataType,
			const TUint8	aGetSet,
			const TUint8	aFormFlag,
			const MMTPType *	aForm
		)	[static]

Parameters

const TUint16 aServicePropCode
const TUint16 aDataType
const TUint8 aGetSet
const TUint8 aFormFlag
const MMTPType * aForm

NextWriteChunk(TPtr8 &)

IMPORT_C TInt

NextWriteChunk

(

TPtr8 &

aChunk

)

[virtual]

Parameters

TPtr8 & aChunk

Type()

IMPORT_C TUint

Type

(

)

const [virtual]

Member Enumerations Documentation

Enum TChunkIds

Data chunk identifiers.

Enumerators

EIdFlat1Chunk	The first flat data chunk ID.
EIdFormChunk	The EForm element data chunk ID.
EIdNumChunks	The number of data chunks.

Enum TMTPObjectPropDescElement

MTP ObjectPropDesc Service Property Description dataset element identifiers.

Enumerators

EServicePropertyCode	Service Property code.
EDataType1	Data-type code
EGetSet1	Get/Set.
EFormFlag	Form Flag .
EForm	FORM element. This element depends EFormFlag and is absent if EFormFlag is ENone.
ENumElements	The number of dataset elements.

Enum TMTPServicePropDescGetSet

MTP ServicePropDesc dataset Get/Set element values.

Enumerators

EReadOnly = 0x00	Get.
EReadWrite = 0x01	Get/Set.

Enum TReadWriteSequenceState

The write data stream states.

Enumerators

EIdle	Data stream is inactive.
EFormChunk	Streaming the EForm data chunk.

Member Data Documentation

const TUint KFlat1ChunkSize

const TUint

KFlat1ChunkSize

[private, static]

const TUint KNumChunksWithForm

const TUint

KNumChunksWithForm

[private, static]

The data chunk count of ObjectPropDesc datasets with an EForm of other than ENone.

const TUint KNumChunksWithoutForm

const TUint

KNumChunksWithoutForm

[private, static]

The data chunk count of ObjectPropDesc datasets with an EForm of ENone.

RMTPTypeCompoundFlatChunk iChunkFlat1

RMTPTypeCompoundFlatChunk

iChunkFlat1

[private]

The flat data chunk comprising elements EPKeyNamespace and EPKeyID.

CMTPTypeObjectPropDesc::RMTPTypeObjectPropDescForm iChunkForm

CMTPTypeObjectPropDesc::RMTPTypeObjectPropDescForm

iChunkForm

[private]

The EForm element data chunk.

const TFixedArray< TElementInfo, ENumElements > iElementInfo

const TFixedArray < TElementInfo , ENumElements >

iElementInfo

[private]

The dataset element metadata table.

const CMTPTypeCompoundBase::TElementInfo iElementMetaData

const CMTPTypeCompoundBase::TElementInfo

iElementMetaData

[private, static]

The dataset element metadata table content.

TUint iWriteSequenceCompletionState

TUint

iWriteSequenceCompletionState

[private]

The write data stream completion state. This will be set to EFlat2Chunk for ObjectPropDesc datasets with an EForm of ENone, otherwise this will be EFormChunk.

TUint iWriteSequenceState

TUint

iWriteSequenceState

[private]

The write data stream state variable.