Symbian^3 Application Developer Library >

CUpnpObject Class Reference

class CUpnpObject : public CBase

UPnP Object header

upnpavobjects.lib
Since
Series 60 3.0

Inherits from

Public Member Functions
~CUpnpObject ()
IMPORT_C void AddElementL ( CUpnpElement *)
IMPORT_C void AddResourceL (const TDesC16 &, const TDesC8 &)
IMPORT_C void CopyL (const CUpnpObject &)
void ExternalizeL ( RWriteStream &)
IMPORT_C const RUPnPElementsArray & GetElements ()
IMPORT_C const TDesC8 & Id ()
void InternalizeL ( RReadStream &)
IMPORT_C const TDesC8 & ObjectClass ()
TUPnPObjectType ObjectType ()
IMPORT_C const TDesC8 & ParentId ()
IMPORT_C void RemoveElementL (const CUpnpElement *)
IMPORT_C TBool Restricted ()
IMPORT_C void SetIdL (const TDesC8 &)
IMPORT_C void SetObjectClassL (const TDesC8 &)
IMPORT_C void SetParentIdL (const TDesC8 &)
IMPORT_C void SetRestricted ( TBool )
IMPORT_C void SetTitleL (const TDesC8 &)
IMPORT_C void SetWriteStatus ( TBool )
IMPORT_C const TDesC8 & Title ()
IMPORT_C HBufC8 * ToDes8L ()
IMPORT_C TBool WriteStatus ()
Protected Member Functions
CUpnpObject ()
void BaseExternalizeL ( RWriteStream &)
void BaseInternalizeL ( RReadStream &)
void ConstructL ()
void SafeExternalizeL ( RWriteStream &, const TDesC8 &, const TInt )
CUpnpObject & operator= (const CUpnpObject &)
Private Member Functions
void ValidateClassL (const TDesC8 &)
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 Attributes
RUPnPElementsArray iElements
HBufC8 * iId
HBufC8 * iObjectClass
HBufC8 * iParentId
TBool iRestricted
HBufC8 * iTitle
TBool iWriteStatus

Constructor & Destructor Documentation

CUpnpObject()

CUpnpObject ( ) [protected]

C++ default constructor.

~CUpnpObject()

IMPORT_C ~CUpnpObject ( ) [virtual]

Destructor.

Member Functions Documentation

AddElementL(CUpnpElement *)

IMPORT_C void AddElementL ( CUpnpElement * aNewElement )
Adds Element for the UPnP Object
Since
Series 60 3.0

Parameters

CUpnpElement * aNewElement

AddResourceL(const TDesC16 &, const TDesC8 &)

IMPORT_C void AddResourceL ( const TDesC16 & aFilename,
const TDesC8 & aProtocolinfo
)
Attaches proper <res> element (resource associated with an UPnP object) to protocolInfo
Since
Series 60 3.0

Parameters

const TDesC16 & aFilename - resource file to be attached
const TDesC8 & aProtocolinfo - protocolInfo to which the resource will be attached

BaseExternalizeL(RWriteStream &)

void BaseExternalizeL ( RWriteStream & aStream ) const [protected]
Externalizes container information to stream. Leaves in case of errors.
Since
Series 60 3.0

Parameters

RWriteStream & aStream

BaseInternalizeL(RReadStream &)

void BaseInternalizeL ( RReadStream & aStream ) [protected]
Internalizes container information from stream. Leaves in case of errors.
Since
Series 60 3.0

Parameters

RReadStream & aStream

ConstructL()

void ConstructL ( ) [protected]

By default Symbian 2nd phase constructor is private.

CopyL(const CUpnpObject &)

IMPORT_C void CopyL ( const CUpnpObject & aObject )
Copies contents from CUpnpObject given as parameter to this object. Leaves in case of errors.
Since
Series 60 3.0

Parameters

const CUpnpObject & aObject const reference to source information

ExternalizeL(RWriteStream &)

void ExternalizeL ( RWriteStream & aStream ) const [pure virtual]
Externalizes container information to stream. Leaves in case of errors.
Since
Series 60 3.0

Parameters

RWriteStream & aStream

GetElements()

IMPORT_C const RUPnPElementsArray & GetElements ( )
Gets Element array of the object
Since
Series 60 3.0

Id()

IMPORT_C const TDesC8 & Id ( ) const
Gets ID for the UPnP Object
Since
Series 60 3.0

InternalizeL(RReadStream &)

void InternalizeL ( RReadStream & aStream ) [pure virtual]
Internalizes container information from stream. Leaves in case of errors.
Since
Series 60 3.0

Parameters

RReadStream & aStream

ObjectClass()

IMPORT_C const TDesC8 & ObjectClass ( ) const
Gets ObjectClass for the UPnP Object
Since
Series 60 3.0

ObjectType()

TUPnPObjectType ObjectType ( ) const [pure virtual]
Pure virtual function to return the concrete object type
Since
Series 60 3.0

ParentId()

IMPORT_C const TDesC8 & ParentId ( ) const
Gets Parent ID for the UPnP Object
Since
Series 60 3.0

RemoveElementL(const CUpnpElement *)

IMPORT_C void RemoveElementL ( const CUpnpElement * aNewElement )
Removes specified Element from the UPnP Object
Since
Series 60 3.0

Parameters

const CUpnpElement * aNewElement

Restricted()

IMPORT_C TBool Restricted ( ) const
Gets the write status.
Since
Series 60 3.0

SafeExternalizeL(RWriteStream &, const TDesC8 &, const TInt)

void SafeExternalizeL ( RWriteStream & aStream,
const TDesC8 & aDesc,
const TInt aNumber
) const [protected]
Safely externalizes object information to stream. Leaves in case of errors.
Since
Series 60 3.0

Parameters

RWriteStream & aStream
const TDesC8 & aDesc
const TInt aNumber

SetIdL(const TDesC8 &)

IMPORT_C void SetIdL ( const TDesC8 & aId )
Gets ID for the UPnP Object
Since
Series 60 3.0

Parameters

const TDesC8 & aId

SetObjectClassL(const TDesC8 &)

IMPORT_C void SetObjectClassL ( const TDesC8 & aObjectClass )
Sets ObjectClass for the UPnP Object. Leaves in case of errors.
Since
Series 60 3.0

Parameters

const TDesC8 & aObjectClass

SetParentIdL(const TDesC8 &)

IMPORT_C void SetParentIdL ( const TDesC8 & aParentId )
Sets Parent ID for the UPnP Object. Leaves in case of errors.
Since
Series 60 3.0

Parameters

const TDesC8 & aParentId

SetRestricted(TBool)

IMPORT_C void SetRestricted ( TBool aRestriction )
Sets the write status.
Since
Series 60 3.0

Parameters

TBool aRestriction

SetTitleL(const TDesC8 &)

IMPORT_C void SetTitleL ( const TDesC8 & aTitle )
Sets title for the UPnP Object. Leaves in case of errors.
Since
Series 60 3.0

Parameters

const TDesC8 & aTitle

SetWriteStatus(TBool)

IMPORT_C void SetWriteStatus ( TBool aWriteStatus )
Sets the write status.
Since
Series 60 3.0

Parameters

TBool aWriteStatus TBool

Title()

IMPORT_C const TDesC8 & Title ( ) const
Gets title for the UPnP Object
Since
Series 60 3.0

ToDes8L()

IMPORT_C HBufC8 * ToDes8L ( ) const

ValidateClassL(const TDesC8 &)

void ValidateClassL ( const TDesC8 & aObjectClass ) [private]

Parameters

const TDesC8 & aObjectClass

WriteStatus()

IMPORT_C TBool WriteStatus ( ) const
Gets the write status.
Since
Series 60 3.0

operator=(const CUpnpObject &)

CUpnpObject & operator= ( const CUpnpObject & aObj ) [protected]

Parameters

const CUpnpObject & aObj

Member Data Documentation

RUPnPElementsArray iElements

RUPnPElementsArray iElements [protected]

HBufC8 * iId

HBufC8 * iId [protected]

HBufC8 * iObjectClass

HBufC8 * iObjectClass [protected]

HBufC8 * iParentId

HBufC8 * iParentId [protected]

TBool iRestricted

TBool iRestricted [protected]

HBufC8 * iTitle

HBufC8 * iTitle [protected]

TBool iWriteStatus

TBool iWriteStatus [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.