speechsrv_plat/vas_api/inc/nssvasctrainingparameters.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:  CTag implements MTag. In addition, it provides members for use
       
    15 *               by VAS internal components.
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef NSSVASCTRAININGPARAMETERS_H
       
    21 #define NSSVASCTRAININGPARAMETERS_H
       
    22 
       
    23 // includes
       
    24 #include <nssvasmspeechitem.h>
       
    25 #include "nssvasmtag.h"
       
    26 #include "nssvasmcontext.h"
       
    27 #include "nssvasmrrd.h"
       
    28 #include "nssvascoreconstant.h"
       
    29 
       
    30 // TYPEDEFS
       
    31 typedef RArray<TLanguage> RTrainingLanguageArray;
       
    32 
       
    33 // CLASS DECLARATION
       
    34 
       
    35 /**
       
    36 *  CTag is the implementation class for MTag interface. 
       
    37 *  It encapsulates tag data. A tag cannot be directly created by a client. 
       
    38 *  A client has to own an instance of Tag Manager which has methods for creating 
       
    39 *  tag objects. The CTag class also provides additional members for internal 
       
    40 *  use by VAS.
       
    41 *  @lib VASApi.lib
       
    42 *  @since 2.8
       
    43 */
       
    44 class CNssTrainingParameters: public CBase
       
    45     {
       
    46     public:
       
    47 
       
    48         /**
       
    49         * Two-phased constructor
       
    50         * @since 2.8
       
    51         * @return Created instance
       
    52         */
       
    53         IMPORT_C static CNssTrainingParameters* NewL();
       
    54 
       
    55         /**
       
    56         * Two-phased constructor
       
    57         * @since 2.8
       
    58         * @return Created instance
       
    59         */
       
    60         IMPORT_C static CNssTrainingParameters* NewLC();
       
    61 
       
    62         /**
       
    63         * Virtuous destructor. Inherited from CBase.
       
    64         * @since 2.8
       
    65         */
       
    66         IMPORT_C virtual ~CNssTrainingParameters();
       
    67 
       
    68         /**
       
    69         * When text is transformed into pronunciation, the outcome depends on
       
    70         * language. List the languages, for which pronunciations should be
       
    71         * generated.
       
    72         * @since 2.8
       
    73         * @param aLanguageArray The list of languages
       
    74         */
       
    75         IMPORT_C void SetLanguages( RArray<TLanguage>* aLanguageArray );
       
    76 
       
    77         /**
       
    78         * When text is transformed into pronunciation, the outcome depends on
       
    79         * language. List the languages, for which pronunciations should be
       
    80         * generated.
       
    81         * @since 2.8
       
    82         * @return Array of languages.
       
    83         */
       
    84         IMPORT_C const RArray<TLanguage>& Languages() const;
       
    85 
       
    86         /**
       
    87         * Set the separator between the first name and the last name.
       
    88         * @since 2.8
       
    89         * @param aSeparator The separator
       
    90         */
       
    91         IMPORT_C void SetSeparator( TChar aSeparator );
       
    92 
       
    93         /**
       
    94         * Returns the separator character.
       
    95         * @since 2.8
       
    96         * @return The separator between the first name and the last name.
       
    97         */
       
    98         IMPORT_C TChar Separator() const;
       
    99         
       
   100         /**
       
   101         * Sets languages for SINDE type of training
       
   102         * @since 3.1
       
   103         * @param aLanguageArray Two dimensional language array
       
   104         */
       
   105         IMPORT_C void SetSindeLanguages( const RArray<RTrainingLanguageArray>& aLanguageArray );
       
   106         
       
   107         /**
       
   108         * Returns the list of SIND training languages.
       
   109         * @since 3.1
       
   110         * @return Array of language arrays
       
   111         */
       
   112         IMPORT_C const RArray<RTrainingLanguageArray>& SindeLanguagesL() const;
       
   113 
       
   114     private:
       
   115     
       
   116         /**
       
   117         * C++ constructor.
       
   118         */
       
   119         CNssTrainingParameters();
       
   120 
       
   121         /**
       
   122         * 2nd phase constructor.
       
   123         */
       
   124         void ConstructL();
       
   125         
       
   126         /**
       
   127         * Destroys SIND language array.
       
   128         */
       
   129         void CNssTrainingParameters::ResetSindeLanguageArray();
       
   130 
       
   131     private:
       
   132 
       
   133         // Word separator
       
   134         TChar iSeparator;
       
   135 
       
   136         // Language array, owned
       
   137         RArray<TLanguage>* iLanguages;
       
   138         
       
   139         // Array of language arrays for SINDE training, owned
       
   140         RArray<RTrainingLanguageArray> iSindeLanguages;
       
   141 };
       
   142 
       
   143 #endif // NSSVASCTRAININGPARAMETERS_H  
       
   144             
       
   145 // End of File