omxil/mmilapi/ilif/inc/tomxilstruct.inl
changeset 0 40261b775718
child 16 eedf2dcd43c6
equal deleted inserted replaced
-1:000000000000 0:40261b775718
       
     1 // Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 /**
       
    17  @file
       
    18  @internalTechnology
       
    19  @prototype
       
    20 */
       
    21 
       
    22 #ifndef TOMXILSTRUCT_INL
       
    23 #define TOMXILSTRUCT_INL
       
    24 
       
    25 
       
    26 /**
       
    27 Constructor
       
    28 
       
    29 @param 	aParam 
       
    30 		The pointer to the structure associated to the particular index stored in this wrapper class.
       
    31 @param 	aIndex 
       
    32 		An index to identify the definition of the structure pointed to by this wrapper class. 
       
    33 */	
       
    34 inline TOMXILStructParam::TOMXILStructParam(TAny* aParam, TILStructIndex aIndex)
       
    35 	: iParam(aParam), iIndex(aIndex)
       
    36 {
       
    37 	ASSERT(aParam);
       
    38 	
       
    39 	iUid = TUid::Uid(KUidOMXILStructType);
       
    40 }
       
    41 
       
    42 
       
    43 /** 
       
    44 Method to return the pointer to the structure represented by the index stored in this TOMXILStructParam.
       
    45 The pointer should be cast to the structure associated to the TILStructIndex stored TOMXILStructParam 
       
    46 
       
    47 @return	A pointer to the OMX IL structure represented by this particular instance of the TOMXILStructParam
       
    48 */
       
    49 inline TAny* TOMXILStructParam::Param() const
       
    50 {
       
    51 	// This is not a const method. The fields in Param could be modified by the client.
       
    52 	return iParam;
       
    53 }
       
    54 
       
    55 	
       
    56 /** 
       
    57 Method to return the TILStructIndex.
       
    58 
       
    59 @return	A TILStructIndex index
       
    60 @see TILStructIndex
       
    61 */
       
    62 inline TILStructIndex TOMXILStructParam::Index() const
       
    63 {
       
    64 	return iIndex;
       
    65 }
       
    66 
       
    67 
       
    68 #endif  // TOMXILSTRUCT_INL