mpx/tsrc/public/basic/collectiontest/inc/testutility.h
author hgs
Tue, 21 Sep 2010 11:25:55 -0500
changeset 62 b276843a15ba
permissions -rw-r--r--
201037
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
62
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002 - 2007 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  Provide common utility function for all test cases
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef TESTUTILITY_H
hgs
parents:
diff changeset
    19
#define TESTUTILITY_H
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
// INCLUDES
hgs
parents:
diff changeset
    22
#include <e32cmn.h>
hgs
parents:
diff changeset
    23
#include <mpxmediageneraldefs.h>
hgs
parents:
diff changeset
    24
#include <mpxmessagegeneraldefs.h>
hgs
parents:
diff changeset
    25
#include <mpxmediaarray.h>
hgs
parents:
diff changeset
    26
#include <mpxmediacontainerdefs.h>
hgs
parents:
diff changeset
    27
#include <mpxcollectionmessagedefs.h>
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
// FORWARD DECLARATIONS
hgs
parents:
diff changeset
    30
class CMPXMedia;
hgs
parents:
diff changeset
    31
class CMPXMediaArray;
hgs
parents:
diff changeset
    32
class CMPXCollectionPath;
hgs
parents:
diff changeset
    33
class CStifLoggger;
hgs
parents:
diff changeset
    34
hgs
parents:
diff changeset
    35
// CONSTANTS
hgs
parents:
diff changeset
    36
hgs
parents:
diff changeset
    37
hgs
parents:
diff changeset
    38
// CLASS DECLARATION
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
/**
hgs
parents:
diff changeset
    41
* This static class contains utilities functions 
hgs
parents:
diff changeset
    42
*/
hgs
parents:
diff changeset
    43
class TestUtility
hgs
parents:
diff changeset
    44
    {
hgs
parents:
diff changeset
    45
public:
hgs
parents:
diff changeset
    46
    /**
hgs
parents:
diff changeset
    47
    * Test whether aTest descriptor attribute  contains in aContainer
hgs
parents:
diff changeset
    48
    * @param aContainer: media 
hgs
parents:
diff changeset
    49
    * @param aTest: media
hgs
parents:
diff changeset
    50
    * @param aAttr: attribute type
hgs
parents:
diff changeset
    51
    * @return ETrue aTest's aAttr is containing in aConatiner
hgs
parents:
diff changeset
    52
    */        
hgs
parents:
diff changeset
    53
    template<typename T> 
hgs
parents:
diff changeset
    54
    static TBool ContainMediaObject(const CMPXMedia& aContainer, const CMPXMedia& aTest, 
hgs
parents:
diff changeset
    55
                                    TMPXAttribute& aAttr, TIdentityRelation<T> anIdentity);
hgs
parents:
diff changeset
    56
    
hgs
parents:
diff changeset
    57
    /**
hgs
parents:
diff changeset
    58
    * Test whether aTest and aContainer are contain media array and match specific content in order
hgs
parents:
diff changeset
    59
    * @param aContainer: media 
hgs
parents:
diff changeset
    60
    * @param aTest: media
hgs
parents:
diff changeset
    61
    * @param aAttr: attribute type
hgs
parents:
diff changeset
    62
    * @return ETrue aTest's aAttr is containing in aConatiner
hgs
parents:
diff changeset
    63
    */
hgs
parents:
diff changeset
    64
    template<typename T> 
hgs
parents:
diff changeset
    65
    static TBool MatchMediaArrayObject(const CMPXMedia& aContainer, const CMPXMedia& aTest, 
hgs
parents:
diff changeset
    66
                                       TMPXAttribute& aAttr, TIdentityRelation<T> anIdentity);
hgs
parents:
diff changeset
    67
    
hgs
parents:
diff changeset
    68
    /**
hgs
parents:
diff changeset
    69
    * Test whether aContainer containing all the T object in aArray with aAttr attribues in order
hgs
parents:
diff changeset
    70
    * @param aContainer: media 
hgs
parents:
diff changeset
    71
    * @param aArray: array of T objects
hgs
parents:
diff changeset
    72
    * @param aAttr: attribute type
hgs
parents:
diff changeset
    73
    * @return ETrue aTest's aAttr is containing in aConatiner
hgs
parents:
diff changeset
    74
    */
hgs
parents:
diff changeset
    75
    template<typename T> 
hgs
parents:
diff changeset
    76
    static TBool MatchMediaArrayObject(const CMPXMedia& aContainer, const RArray<T>& aArray, 
hgs
parents:
diff changeset
    77
                                       TMPXAttribute& aAttr, TIdentityRelation<T> anIdentity);
hgs
parents:
diff changeset
    78
hgs
parents:
diff changeset
    79
    /**
hgs
parents:
diff changeset
    80
    * Test whether aContainer containing all the text object in aArray with aAttr attribues in order
hgs
parents:
diff changeset
    81
    * @param aContainer: media 
hgs
parents:
diff changeset
    82
    * @param aArray: array of text objects
hgs
parents:
diff changeset
    83
    * @param aAttr: attribute type
hgs
parents:
diff changeset
    84
    * @return ETrue aTest's aAttr is containing in aConatiner
hgs
parents:
diff changeset
    85
    */
hgs
parents:
diff changeset
    86
    static TBool MatchMediaArrayTextObject(const CMPXMedia& aContainer, const MDesC16Array& aArray, 
hgs
parents:
diff changeset
    87
                                           TMPXAttribute& aAttr);
hgs
parents:
diff changeset
    88
                                           
hgs
parents:
diff changeset
    89
    
hgs
parents:
diff changeset
    90
    /**
hgs
parents:
diff changeset
    91
    * Log the content of collection path. Only selection of each level and top level Ids are logged
hgs
parents:
diff changeset
    92
    * @param aPath a path to log
hgs
parents:
diff changeset
    93
    * @param aLogger a logger to log the message
hgs
parents:
diff changeset
    94
    */
hgs
parents:
diff changeset
    95
    //static void LogCollectionPath(CMPXCollectionPath& aPath, CStifLogger* aLogger);
hgs
parents:
diff changeset
    96
    
hgs
parents:
diff changeset
    97
private:
hgs
parents:
diff changeset
    98
    /**
hgs
parents:
diff changeset
    99
    * Test whether aMedia1 and aMedia2 support same attribute
hgs
parents:
diff changeset
   100
    * @param aMedia1: media 
hgs
parents:
diff changeset
   101
    * @param aMedia2: media
hgs
parents:
diff changeset
   102
    * @param aAttr: attribute type to match
hgs
parents:
diff changeset
   103
    * @return ETrue aMedia1 and aMedia2 has same aAttr attribute
hgs
parents:
diff changeset
   104
    */        
hgs
parents:
diff changeset
   105
    static TBool ValidateMediaObject(const CMPXMedia& aMedia1, const CMPXMedia& aMedia2,
hgs
parents:
diff changeset
   106
                                     TMPXAttribute& aAttr);
hgs
parents:
diff changeset
   107
                                     
hgs
parents:
diff changeset
   108
    /**
hgs
parents:
diff changeset
   109
    * Test whether aMedia1 and aMedia2 support same array attribute
hgs
parents:
diff changeset
   110
    * @param aMedia1: media 
hgs
parents:
diff changeset
   111
    * @param aMedia2: media
hgs
parents:
diff changeset
   112
    * @return ETrue aMedia1 and aMedia2 has same aAttr attribute
hgs
parents:
diff changeset
   113
    */        
hgs
parents:
diff changeset
   114
    static TBool ValidateMediaArrayObject(const CMPXMedia& aMedia1, const CMPXMedia& aMedia2);
hgs
parents:
diff changeset
   115
    
hgs
parents:
diff changeset
   116
    /**
hgs
parents:
diff changeset
   117
    * Test whether aMedia is media array and same count as aArray
hgs
parents:
diff changeset
   118
    * @param aMedia: media 
hgs
parents:
diff changeset
   119
    * @param aArray: an array of items
hgs
parents:
diff changeset
   120
    * @return ETrue aMedia is array object and same count as aArray
hgs
parents:
diff changeset
   121
    */        
hgs
parents:
diff changeset
   122
    static TBool ValidateMediaArrayObject(const CMPXMedia& aMedia, TInt aArrayCnt);
hgs
parents:
diff changeset
   123
    };
hgs
parents:
diff changeset
   124
hgs
parents:
diff changeset
   125
#include "testutility.inl"
hgs
parents:
diff changeset
   126
hgs
parents:
diff changeset
   127
#endif  // TESTUTILITY_H