author | William Roberts <williamr@symbian.org> |
Wed, 31 Mar 2010 12:33:34 +0100 | |
branch | Symbian3 |
changeset 4 | 837f303aceeb |
parent 2 | 2fe1408b6811 |
permissions | -rw-r--r-- |
williamr@2 | 1 |
/* |
williamr@2 | 2 |
* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies). |
williamr@2 | 3 |
* All rights reserved. |
williamr@2 | 4 |
* This component and the accompanying materials are made available |
williamr@4 | 5 |
* under the terms of "Eclipse Public License v1.0" |
williamr@2 | 6 |
* which accompanies this distribution, and is available |
williamr@4 | 7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html". |
williamr@2 | 8 |
* |
williamr@2 | 9 |
* Initial Contributors: |
williamr@2 | 10 |
* Nokia Corporation - initial contribution. |
williamr@2 | 11 |
* |
williamr@2 | 12 |
* Contributors: |
williamr@2 | 13 |
* |
williamr@2 | 14 |
* Description: PosLandmarkSerialization class definition |
williamr@2 | 15 |
* |
williamr@2 | 16 |
*/ |
williamr@2 | 17 |
|
williamr@2 | 18 |
|
williamr@2 | 19 |
#ifndef __EPOS_POSLANDMARKSERIALIZATION_H |
williamr@2 | 20 |
#define __EPOS_POSLANDMARKSERIALIZATION_H |
williamr@2 | 21 |
|
williamr@2 | 22 |
#include <e32base.h> |
williamr@2 | 23 |
|
williamr@2 | 24 |
class CPosLandmark; |
williamr@2 | 25 |
|
williamr@2 | 26 |
/** |
williamr@2 | 27 |
* This class contains helper methods for landmark serialization. |
williamr@2 | 28 |
* A landmark can be packed into a buffer with PackL method and unpacked |
williamr@2 | 29 |
* back with UnpackL method. |
williamr@2 | 30 |
* |
williamr@2 | 31 |
* @lib eposlandmarks.lib |
williamr@2 | 32 |
* @since S60 3.1 |
williamr@2 | 33 |
*/ |
williamr@2 | 34 |
class PosLandmarkSerialization |
williamr@2 | 35 |
{ |
williamr@2 | 36 |
public: |
williamr@2 | 37 |
/** Packs landmark object into a buffer. |
williamr@2 | 38 |
* |
williamr@2 | 39 |
* All the data is preserved when packing. Database information is not stored. |
williamr@2 | 40 |
* Packed landmark can be unpacked with @ref UnpackL method. |
williamr@2 | 41 |
* |
williamr@2 | 42 |
* @param aLandmark The landmark to be packed. |
williamr@2 | 43 |
* @return The buffer with the landmark data packed. |
williamr@2 | 44 |
* Ownership is transferred to the client. |
williamr@2 | 45 |
*/ |
williamr@2 | 46 |
IMPORT_C static HBufC8* PackL( const CPosLandmark& aLandmark ); |
williamr@2 | 47 |
|
williamr@2 | 48 |
/** Unpacks a landmark object, packed with @ref PackL method, from buffer. |
williamr@2 | 49 |
* |
williamr@2 | 50 |
* All the data is preserved when packing, and restored exactly |
williamr@2 | 51 |
* when unpacking. It means that landmark ID and |
williamr@2 | 52 |
* category IDs are valid only for the database, this landmark was read from. |
williamr@2 | 53 |
* |
williamr@2 | 54 |
* @param aBuffer The buffer containing landmark. |
williamr@2 | 55 |
* @return The landmark unpacked. Ownership is transferred to client. |
williamr@2 | 56 |
* @leave KErrCorrupt if buffer does not contain valid landmark package. |
williamr@2 | 57 |
*/ |
williamr@2 | 58 |
IMPORT_C static CPosLandmark* UnpackL( const TDesC8& aBuffer ); |
williamr@2 | 59 |
}; |
williamr@2 | 60 |
|
williamr@2 | 61 |
#endif // __EPOS_POSLANDMARKSERIALIZATION_H |