speechsrv_plat/vas_api/inc/nssvasmrrd.h
branchRCL_3
changeset 19 e36f3802f733
parent 0 bf1d17376201
equal deleted inserted replaced
18:cad71a31b7fc 19:e36f3802f733
       
     1 /*
       
     2 * Copyright (c) 2002-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:  MRRD class encapsulated a Recognition Result Data (RRD). RRD serves 
       
    15 *               as a container for client defined data (text and integers) that 
       
    16 *               needs to be associated with a voice tag.
       
    17 *
       
    18 */
       
    19 
       
    20 
       
    21 #ifndef NSSVASMRRD_H
       
    22 #define NSSVASMRRD_H
       
    23 
       
    24 //  INCLUDES
       
    25 #include <e32base.h>
       
    26 
       
    27 // maximum length for RRD Text
       
    28 const TInt KNssVASMAXRRDTextLength = 64;
       
    29 
       
    30 // typedef
       
    31 typedef TBuf<KNssVASMAXRRDTextLength> NssRRDText;
       
    32 
       
    33 // CLASS DECLARATION
       
    34 
       
    35 /**
       
    36 * MRRD is the interface for Recognition Result Data (RRD) processing. It provides methods 
       
    37 * for setting and getting the text and integer array that comprise the RRD. A RRD
       
    38 * is part of Tag. RRD is not created by the client, it is created when a tag is created
       
    39 * and destroyed when the tag is destroyed. Thus, a client doesnot delete an RRD.
       
    40 * @lib NssVASApi.lib
       
    41 * @since 2.0
       
    42 */
       
    43 class MNssRRD
       
    44 {
       
    45 public:
       
    46 
       
    47     /**
       
    48     * Get the text array in RRD
       
    49 	* @since 2.0
       
    50     * @param 
       
    51     * @return an array of text
       
    52     */
       
    53 	virtual CArrayFixFlat<NssRRDText>* TextArray() = 0;
       
    54 
       
    55     /**
       
    56     * Get the integer array in RRD
       
    57 	* @since 2.0
       
    58     * @param 
       
    59     * @return an array of integers
       
    60     */
       
    61 	virtual CArrayFixFlat<TInt>* IntArray() = 0;
       
    62 
       
    63     /**
       
    64     * Set the text array in RRD
       
    65 	* @since 2.0
       
    66     * @param aTextArray pointer to an array of text
       
    67     * @return
       
    68     */
       
    69 	virtual void SetTextArrayL(CArrayFixFlat<NssRRDText>* aTextArray) = 0;
       
    70 
       
    71     /**
       
    72     * Set the integer array in RRD
       
    73 	* @since 2.0
       
    74     * @param aIntArray pointer to an array of integers
       
    75     * @return 
       
    76     */
       
    77 	virtual void SetIntArrayL(CArrayFixFlat<TInt>* aIntArray) = 0;
       
    78 
       
    79 };
       
    80 
       
    81 #endif // NSSVASMRRD_H  
       
    82             
       
    83 // End of File