bluetoothengine/headsetsimulator/profiles/hspprofile/inc/dataprocessing/hspcommandparser.h
author michal.sulewski
Wed, 15 Sep 2010 15:59:44 +0200
branchheadsetsimulator
changeset 60 90dbfc0435e3
permissions -rw-r--r--
source code commit
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
60
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     1
/* 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     2
 *
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     3
 * Copyright (c) <2010> Comarch S.A. and/or its subsidiary(-ies).
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     4
 * All rights reserved.
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     5
 * This component and the accompanying materials are made available
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     6
 * under the terms of the License "Eclipse Public License v1.0"
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     7
 * which accompanies this distribution, and is available
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     8
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     9
 *
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    10
 * Original Contributors:
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    11
 * Comarch S.A. - original contribution.
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    12
 *
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    13
 * Contributors:
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    14
 *
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    15
 * Description:
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    16
 *
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    17
 */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    18
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    19
#ifndef HSPCOMMANDPARSER_H_
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    20
#define HSPCOMMANDPARSER_H_
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    21
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    22
#include <e32base.h>
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    23
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    24
#include "hspcommand.h"
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    25
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    26
/**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    27
 *  @brief Parser for AT commands 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    28
 */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    29
class CHsHSPParser : public CBase
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    30
{
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    31
public:
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    32
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    33
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    34
     * Two-phased constructor.
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    35
     * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    36
     * @return class instance
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    37
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    38
    static CHsHSPParser* NewL();
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    39
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    40
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    41
     * Two-phased constructor.
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    42
     * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    43
     * @return class instance
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    44
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    45
    static CHsHSPParser* NewLC();
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    46
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    47
    /** 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    48
     * Destructor
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    49
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    50
    ~CHsHSPParser();
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    51
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    52
public:
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    53
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    54
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    55
     * Parses 8-bit descriptor into AT command
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    56
     * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    57
     * @param aBufCommand descriptor to be parsed
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    58
     * @param aFromAG is data passed from AG
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    59
     * @param aCommand result (AT command)
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    60
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    61
    void ParseL( const TDesC8 &aBufCommand, const TBool aFromAG,
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    62
            CHsHSPCommand& aCommand );
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    63
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    64
private:
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    65
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    66
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    67
     * Contructor for performing 1st stage construction
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    68
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    69
    CHsHSPParser();
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    70
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    71
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    72
     * Constructor for performing 2nd stage contruction
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    73
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    74
    void ConstructL();
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    75
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    76
private:
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    77
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    78
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    79
     * Retrieves command's mode from descriptor data
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    80
     * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    81
     * @param aCommand descriptor to be parsed
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    82
     * @param aFromAG denotes if data sent from AG
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    83
     * @return command's mode 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    84
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    85
    THsHSPCommandMode RetrieveModeL( const TDesC8 &aCommand,
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    86
            const TBool aFromAG );
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    87
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    88
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    89
     * Retrieves command's type from descriptor data
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    90
     * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    91
     * @param aCommand descriptor to be parsed
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    92
     * @return command's type 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    93
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    94
    THsHSPCommandType RetrieveTypeL( const TDesC8 &aCommand );
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    95
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    96
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    97
     * Retrieves command's params from descriptor data
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    98
     * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    99
     * @param aCommand descriptor to be parsed
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   100
     * @param aCmdMode command's mode
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   101
     * @param aParams reference for array of params
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   102
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   103
    void RetrieveParamsL( const TDesC8 &aCommand,
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   104
            const THsHSPCommandMode aCmdMode, RATParamArray& aParams );
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   105
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   106
};
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   107
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   108
#endif /* HSPCOMMANDPARSER_H_ */