srsf/nssvasapi/nssvascore/inc/nssvascrrd.h
branchRCL_3
changeset 19 e36f3802f733
parent 0 bf1d17376201
equal deleted inserted replaced
18:cad71a31b7fc 19:e36f3802f733
       
     1 /*
       
     2 * Copyright (c) 2004-2006 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  CNssRRD class encapsulated a RRD. It implements MNssRRD.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef NSSVASCRRD_H
       
    20 #define NSSVASCRRD_H
       
    21 
       
    22 //  INCLUDES
       
    23 #include "nssvasmrrd.h"
       
    24 #include "nssvascoreconstant.h"
       
    25 
       
    26 // CLASS DECLARATION
       
    27 
       
    28 /**
       
    29 *  CNssRRD encapsulates result recognition data. 
       
    30 *  It is the implementation class for MNssRRD. In addition to methods in MNssRRD, 
       
    31 *  it also provides methods for internal use by VAS components.
       
    32 *  @lib NssVASApi.lib
       
    33 *  @since 2.8
       
    34 */
       
    35 
       
    36 class CNssRRD: public  CBase, public MNssRRD
       
    37 {
       
    38 public:
       
    39 
       
    40     /**
       
    41     * C++ destructor.
       
    42     */
       
    43 	~CNssRRD();
       
    44 
       
    45     /**
       
    46     * 2 phase construction
       
    47     */
       
    48 	static CNssRRD* NewL(); 
       
    49 
       
    50     /**
       
    51     * 2 phase construction
       
    52     */
       
    53 	static CNssRRD* NewLC();
       
    54 
       
    55     /**
       
    56     * Set the tag id for this context
       
    57 	* @param aTagId tag id for the context
       
    58     * @return 
       
    59     */
       
    60 	void SetTagId(TInt aTagId);
       
    61 
       
    62 	 /**
       
    63     * Get the tag id for this context
       
    64     * @since 2.0
       
    65     * @param 
       
    66     * @return tag id
       
    67     */  
       
    68 	TInt TagId();
       
    69 
       
    70 	/**
       
    71     * Creates a deep copy of the RRD object and returns a pointer
       
    72 	* to the newly created RRD. A client calling calling
       
    73 	* this method takes the responsibility of deleting the new RRD object.
       
    74 	* For internal use by by VAS components.
       
    75 	* @since 2.0
       
    76     * @param 
       
    77     * @return pointer to newly created rrd
       
    78     */
       
    79 	CNssRRD *CopyL();
       
    80 
       
    81 public: // from MNssRRD
       
    82 
       
    83 	/**
       
    84     * Get the text array for this RRD
       
    85 	* @since 2.0
       
    86     * @param 
       
    87     * @return pointer to text array
       
    88     */  
       
    89 	 CArrayFixFlat<NssRRDText>* TextArray();
       
    90 
       
    91 	/**
       
    92     * Get the integer array this RRD
       
    93 	* @since 2.0
       
    94     * @param 
       
    95     * @return pointer to integer array
       
    96     */  
       
    97 	 CArrayFixFlat<TInt>* IntArray();
       
    98 
       
    99 	/**
       
   100     * Set the text array for this RRD
       
   101 	* @since 2.0
       
   102     * @param pointer to text array
       
   103     * @return 
       
   104     */  
       
   105 	 void SetTextArrayL(CArrayFixFlat<NssRRDText>* aTextArray);
       
   106 
       
   107 	/**
       
   108     * Set the integer array this RRD
       
   109 	* @since 2.0
       
   110     * @param pointer to integer array
       
   111     * @return 
       
   112     */  
       
   113 	 void SetIntArrayL(CArrayFixFlat<TInt>* aIntArray);
       
   114 
       
   115 private:
       
   116 
       
   117 	/**
       
   118     * C++ constructor.
       
   119     */
       
   120 	CNssRRD();
       
   121 
       
   122 	/**
       
   123     * EPOC constructor.
       
   124     */
       
   125 	void ConstructL();
       
   126 
       
   127 private:
       
   128 
       
   129 	// text array
       
   130 	CArrayFixFlat<NssRRDText>* iTextArray;
       
   131 
       
   132 	// integer array
       
   133 	CArrayFixFlat<TInt>*	iIntArray;
       
   134 
       
   135 	// tag id, for internal use by VAS DB
       
   136 	TInt					iTagId; 
       
   137 };
       
   138 
       
   139 
       
   140 #endif // NSSVASCRRD_H  
       
   141             
       
   142 // End of File