Collapse all Symbian^3 Application Developer Library

conn::CDataOwnerInfo Class Reference

class conn::CDataOwnerInfo : public CBase

CDataOwnerInfo packages up information for the backup / restore client on an individual data owner.

Access to the data members is direct.

CDataOwnerInfo packages up information for the backup / restore client on an individual data owner.

Access to the data members is direct.

Inherits from

conn::CDataOwnerInfo
- CBase

Public Member Functions
	~CDataOwnerInfo ()
IMPORT_C TDriveList &	DriveList ()
IMPORT_C HBufC8 *	ExternaliseL ()
IMPORT_C HBufC8 *	ExternaliseLC ()
IMPORT_C CSBGenericDataType &	Identifier ()
IMPORT_C const CSBGenericDataType &	Identifier ()
IMPORT_C CDataOwnerInfo *	NewL ( CSBGenericDataType *, TCommonBURSettings , TPassiveBURSettings , TActiveBURSettings , const TDriveList &)
IMPORT_C CDataOwnerInfo *	NewL (const TDesC8 &)
IMPORT_C TPassiveBURSettings	PassiveSettings ()
IMPORT_C TInt	Size ()

Private Member Functions
	CDataOwnerInfo ()
void	ConstructL ( CSBGenericDataType *, TCommonBURSettings , TPassiveBURSettings , TActiveBURSettings , const TDriveList &)
void	ConstructL (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()

Private Attributes
TActiveBURSettings	iActiveBURSettings
TCommonBURSettings	iCommonBURSettings
TDriveList	iDriveList
CSBGenericDataType *	iGenericDataType
TPassiveBURSettings	iPassiveBURSettings

Constructor & Destructor Documentation

CDataOwnerInfo()

CDataOwnerInfo

(

)

[private]

C++ Constructor

~CDataOwnerInfo()

IMPORT_C

~CDataOwnerInfo

(

)

C++ Destructor

Member Functions Documentation

ConstructL(CSBGenericDataType *, TCommonBURSettings, TPassiveBURSettings, TActiveBURSettings, const TDriveList &)

void	ConstructL	(	CSBGenericDataType *	aGenericDataType,
			TCommonBURSettings	aCommonSettings,
			TPassiveBURSettings	aPassiveSettings,
			TActiveBURSettings	aActiveSettings,
			const TDriveList &	aDriveList
		)	[private]

Symbian OS 2nd phase constructor.

Parameters

CSBGenericDataType * aGenericDataType	pointer to CSBGenericDataType object
TCommonBURSettings aCommonSettings	flags for storing common backup and restore settings
TPassiveBURSettings aPassiveSettings	flags for storing passive backup and restore settings
TActiveBURSettings aActiveSettings	flags for storing active backup and restore settings
const TDriveList & aDriveList	the array of drives the data owner has data on

ConstructL(const TDesC8 &)

void

ConstructL

(

const TDesC8 &

aFlatDataOwnerInfo

)

[private]

Parameters

const TDesC8 & aFlatDataOwnerInfo

DriveList()

IMPORT_C TDriveList &

DriveList

(

)

Getter method for returning the list of drives on which the Data Owner stores data to be backed up

ExternaliseL()

IMPORT_C HBufC8 *

ExternaliseL

(

)

Method to externalise the data owner so that it can be passed flat over the IPC interface or appended to a PC bound message, pops the pointer off the cleanup stack before it is returned

ExternaliseLC()

IMPORT_C HBufC8 *

ExternaliseLC

(

)

Identifier()

IMPORT_C CSBGenericDataType &

Identifier

(

)

Identifier()

IMPORT_C const CSBGenericDataType &

Identifier

(

)

const

NewL(CSBGenericDataType *, TCommonBURSettings, TPassiveBURSettings, TActiveBURSettings, const TDriveList &)

IMPORT_C CDataOwnerInfo *	NewL	(	CSBGenericDataType *	aGenericDataType,
			TCommonBURSettings	aCommonSettings,
			TPassiveBURSettings	aPassiveSettings,
			TActiveBURSettings	aActiveSettings,
			const TDriveList &	aDriveList
		)	[static]

Symbian constructor. This constructor is used to create a CDataOwnerInfo from it's constituent parts, rather than from an externalised class etc.

Parameters

CSBGenericDataType * aGenericDataType	pointer to CSBGenericDataType object
TCommonBURSettings aCommonSettings	flags for storing common backup and restore settings
TPassiveBURSettings aPassiveSettings	flags for storing passive backup and restore settings
TActiveBURSettings aActiveSettings	flags for storing active backup and restore settings
const TDriveList & aDriveList	the array of drives the data owner has data on

NewL(const TDesC8 &)

IMPORT_C CDataOwnerInfo *

NewL

(

const TDesC8 &

aFlatDataOwnerInfo

)

[static]

Symbian constructor for constructing a CDataOwnerInfo object from an externalised CDataOwnerInfo object. This may be used when taking an externalised class out of a PC message or over IPC.

Parameters

const TDesC8 & aFlatDataOwnerInfo

a flat data owner info returned from IPC

PassiveSettings()

IMPORT_C TPassiveBURSettings

PassiveSettings

(

)

const

Getter method for returning the Passive Backup and Restore flags that the were specified in the Data Owner's backup registration file

Size()

IMPORT_C TInt

Size

(

)

const

Getter for returning the total flattened size of the object. Used for calculating the size of a descriptor to fit the externalised instance of this object

Member Data Documentation

TActiveBURSettings iActiveBURSettings

TActiveBURSettings

iActiveBURSettings

[private]

flags for storing active backup and restore settings

TCommonBURSettings iCommonBURSettings

TCommonBURSettings

iCommonBURSettings

[private]

flags for storing common backup and restore settings

TDriveList iDriveList

TDriveList

iDriveList

[private]

List of drives that the data owner has data on

CSBGenericDataType * iGenericDataType

CSBGenericDataType *

iGenericDataType

[private]

generic data type object

TPassiveBURSettings iPassiveBURSettings

TPassiveBURSettings

iPassiveBURSettings

[private]

flags for storing passive backup and restore settings