bthci/hci2implementations/qdps/symbian/inc/hcieventmodifiable.h
changeset 0 29b1cd4cb562
child 1 b4a7eebaaebf
equal deleted inserted replaced
-1:000000000000 0:29b1cd4cb562
       
     1 // Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 /**
       
    17  @file
       
    18  @internalComponent
       
    19 */
       
    20 
       
    21 #ifndef HCIEVENTMODIFIABLE_H
       
    22 #define HCIEVENTMODIFIABLE_H
       
    23 
       
    24 #include <bluetooth/hci/event.h>
       
    25 
       
    26 enum THCIEventModifiablePanic
       
    27 	{
       
    28 	EIllegalConstructorUse = 0
       
    29 	};
       
    30 
       
    31 /**
       
    32 This class represents a QDP that is relevant for hardware that is perfect,
       
    33 and so the Command Queue can operate normally without any special considerations.
       
    34 */
       
    35 class THCIEventModifiable : public THCIEventBase
       
    36 	{
       
    37 public:
       
    38     /**
       
    39 	 * Setter for the error code.
       
    40 	 *
       
    41 	 * Although this error code is not defined for all events in the HCI specification, the error code
       
    42 	 * is in the base class so that the command queue can use the event error in its decisions without casting
       
    43 	 * to a derived class.
       
    44 	 * Those events that do not contain an error code in the specification should return with THCIErrorCode::EOK.
       
    45 	 *
       
    46 	 * @param aErrorCode The value the error code should be set to
       
    47 	 */
       
    48 
       
    49 	void SetErrorCode(THCIErrorCode aErrorCode);
       
    50 
       
    51 private:
       
    52 	/* explicit constructor */
       
    53 	THCIEventModifiable();
       
    54 	};
       
    55 
       
    56 #endif // HCIEVENTMODIFIABLE_H