bluetoothengine/headsetsimulator/remotecontroller/inc/remotecontrol/hsrccommand.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
 * Component Name: Headset Simulator
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     3
 * Author: Comarch S.A.
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     4
 * Version: 1.0
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     5
 * Copyright (c) 2010 Comarch S.A.
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     6
 *  
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     7
 * This Software is submitted by Comarch S.A. to Symbian Foundation Limited on 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     8
 * the basis of the Member Contribution Agreement entered between Comarch S.A. 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     9
 * and Symbian Foundation Limited on 5th June 2009 (“Agreement”) and may be 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    10
 * used only in accordance with the terms and conditions of the Agreement. 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    11
 * Any other usage, duplication or redistribution of this Software is not 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    12
 * allowed without written permission of Comarch S.A.
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    13
 * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    14
 */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    15
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    16
#ifndef HSRCCOMMAND_H
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    17
#define HSRCCOMMAND_H
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    18
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    19
#include <e32base.h>
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    20
#include <hsremoterequest.h>
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    21
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    22
/** Length of package */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    23
const TInt KHsRemoteControlPackageLength = 128;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    24
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    25
/** Length of package's header */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    26
const TInt KHsRemoteControlPackageTypeMaxLength = 2;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    27
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    28
/** Headset Simulator's remote control command */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    29
typedef TBuf8 <KHsRemoteControlPackageLength> THsRCCommandData;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    30
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    31
/**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    32
 * @brief Represents command for remote control of Headset Simulator
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    33
 */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    34
class THsRCCommand
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    35
{
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    36
public:
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    37
        
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    38
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    39
     * Constructor
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    40
     * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    41
     * @param aData command's data
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    42
     * @param aCommandType type of command
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    43
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    44
    THsRCCommand( THsRCCommandData& aData, 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    45
            THsRemoteControlCommandType aCommandType );
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
     * Represents THsRCCommand as 8-bit descriptor
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    49
     * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    50
     * @param aCommandDesc parameter containing response
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    51
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    52
    void ToDes8( TDes8& aCommandDesc );
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
     * Clones THsRCCommand object
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    56
     * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    57
     * @param aCmdFrom source
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    58
     * @param aCmdTo destination 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    59
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    60
    static void Copy( const THsRCCommand& aCmdFrom, THsRCCommand& aCmdTo );
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    61
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    62
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    63
     * Getter for type of command
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    64
     * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    65
     * @return command type
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    66
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    67
    THsRemoteControlCommandType Type() const;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    68
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    69
private:
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    70
    /** Command data */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    71
    THsRCCommandData& iData;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    72
    
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    73
    /** Command type */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    74
    THsRemoteControlCommandType iType;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    75
};
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    76
#endif // HSRCOMMAND_H