bthci/hci2implementations/qdps/symbian/inc/hcieventmodifiable.h
changeset 0 29b1cd4cb562
child 1 b4a7eebaaebf
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/bthci/hci2implementations/qdps/symbian/inc/hcieventmodifiable.h	Fri Jan 15 08:13:17 2010 +0200
@@ -0,0 +1,56 @@
+// Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
+// All rights reserved.
+// This component and the accompanying materials are made available
+// under the terms of "Eclipse Public License v1.0"
+// which accompanies this distribution, and is available
+// at the URL "http://www.eclipse.org/legal/epl-v10.html".
+//
+// Initial Contributors:
+// Nokia Corporation - initial contribution.
+//
+// Contributors:
+//
+// Description:
+//
+
+/**
+ @file
+ @internalComponent
+*/
+
+#ifndef HCIEVENTMODIFIABLE_H
+#define HCIEVENTMODIFIABLE_H
+
+#include <bluetooth/hci/event.h>
+
+enum THCIEventModifiablePanic
+	{
+	EIllegalConstructorUse = 0
+	};
+
+/**
+This class represents a QDP that is relevant for hardware that is perfect,
+and so the Command Queue can operate normally without any special considerations.
+*/
+class THCIEventModifiable : public THCIEventBase
+	{
+public:
+    /**
+	 * Setter for the error code.
+	 *
+	 * Although this error code is not defined for all events in the HCI specification, the error code
+	 * is in the base class so that the command queue can use the event error in its decisions without casting
+	 * to a derived class.
+	 * Those events that do not contain an error code in the specification should return with THCIErrorCode::EOK.
+	 *
+	 * @param aErrorCode The value the error code should be set to
+	 */
+
+	void SetErrorCode(THCIErrorCode aErrorCode);
+
+private:
+	/* explicit constructor */
+	THCIEventModifiable();
+	};
+
+#endif // HCIEVENTMODIFIABLE_H